db_cluster_parameter_groups

Creates, updates, deletes or gets a db_cluster_parameter_group resource or lists db_cluster_parameter_groups in a region

Overview

Name	db_cluster_parameter_groups
Type	Resource
Description	The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*. If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
Id	aws.rds.db_cluster_parameter_groups

Fields

Name	Datatype	Description
description	string	The description for the DB cluster parameter group.
family	string	The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. *Aurora MySQL* Example: aurora-mysql5.7, aurora-mysql8.0 *Aurora PostgreSQL* Example: aurora-postgresql14 *RDS for MySQL* Example: mysql8.0 *RDS for PostgreSQL* Example: postgres13 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values: + aurora-mysql + aurora-postgresql + mysql + postgres
parameters	object	Provides a list of parameters for the DB cluster parameter group.
db_cluster_parameter_group_name	string	The name of the DB cluster parameter group. Constraints: + Must not match the name of an existing DB cluster parameter group. This value is stored as a lowercase string.
tags	array	Tags to assign to the DB cluster parameter group.
region	string	AWS region.

For more information, see AWS::RDS::DBClusterParameterGroup.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Description, Family, Parameters, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all db_cluster_parameter_groups in a region.

SELECT
region,
description,
family,
parameters,
db_cluster_parameter_group_name,
tags
FROM aws.rds.db_cluster_parameter_groups
WHERE region = 'us-east-1';

Gets all properties from an individual db_cluster_parameter_group.

SELECT
region,
description,
family,
parameters,
db_cluster_parameter_group_name,
tags
FROM aws.rds.db_cluster_parameter_groups
WHERE region = 'us-east-1' AND data__Identifier = '<DBClusterParameterGroupName>';

INSERT example

Use the following StackQL query and manifest file to create a new db_cluster_parameter_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.rds.db_cluster_parameter_groups (
 Description,
 Family,
 Parameters,
 region
)
SELECT 
'{{ Description }}',
 '{{ Family }}',
 '{{ Parameters }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.rds.db_cluster_parameter_groups (
 Description,
 Family,
 Parameters,
 DBClusterParameterGroupName,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Family }}',
 '{{ Parameters }}',
 '{{ DBClusterParameterGroupName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: db_cluster_parameter_group
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Family
        value: '{{ Family }}'
      - name: Parameters
        value: {}
      - name: DBClusterParameterGroupName
        value: '{{ DBClusterParameterGroupName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.rds.db_cluster_parameter_groups
WHERE data__Identifier = '<DBClusterParameterGroupName>'
AND region = 'us-east-1';

Permissions

To operate on the db_cluster_parameter_groups resource, the following permissions are required:

Create

iam:CreateServiceLinkedRole,
rds:AddTagsToResource,
rds:CreateDBClusterParameterGroup,
rds:DescribeDBClusterParameterGroups,
rds:DescribeDBClusterParameters,
rds:DescribeDBClusters,
rds:DescribeEngineDefaultClusterParameters,
rds:ListTagsForResource,
rds:ModifyDBClusterParameterGroup,
rds:RemoveTagsFromResource

Read

rds:DescribeDBClusterParameterGroups,
rds:DescribeDBClusterParameters,
rds:DescribeEngineDefaultClusterParameters,
rds:ListTagsForResource

Update

rds:AddTagsToResource,
rds:DescribeDBClusterParameterGroups,
rds:DescribeDBClusterParameters,
rds:DescribeDBClusters,
rds:DescribeEngineDefaultClusterParameters,
rds:ListTagsForResource,
rds:ModifyDBClusterParameterGroup,
rds:RemoveTagsFromResource,
rds:ResetDBClusterParameterGroup

Delete

rds:DeleteDBClusterParameterGroup

List

rds:DescribeDBClusterParameterGroups