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	`awscc.rds.db_cluster_parameter_groups`

Fields

get (all properties)
list (identifiers only)

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.<br />Aurora MySQL <br />Example: ``aurora-mysql5.7``, ``aurora-mysql8.0``<br />Aurora PostgreSQL <br />Example: ``aurora-postgresql14``<br />RDS for MySQL <br />Example: ``mysql8.0``<br />RDS for PostgreSQL <br />Example: ``postgres13``<br />To list all of the available parameter group families for a DB engine, use the following command:<br />``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`` <br />For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:<br />``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql`` <br />The output contains duplicates.<br />The following are the valid DB engine values:<br />+ ``aurora-mysql`` <br />+ ``aurora-postgresql`` <br />+ ``mysql`` <br />+ ``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.<br />Constraints:<br />+ Must not match the name of an existing DB cluster parameter group.<br /><br />This value is stored as a lowercase string.
▶`tags`	`array`	Tags to assign to the DB cluster parameter group.
`region`	`string`	AWS region.

Name	Datatype	Description
`db_cluster_parameter_group_name`	`string`	The name of the DB cluster parameter group.<br />Constraints:<br />+ Must not match the name of an existing DB cluster parameter group.<br /><br />This value is stored as a lowercase string.
`region`	`string`	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
`create_resource`	`db_cluster_parameter_groups`	`INSERT`	`Description, Family, Parameters, region`
`delete_resource`	`db_cluster_parameter_groups`	`DELETE`	`Identifier, region`
`update_resource`	`db_cluster_parameter_groups`	`UPDATE`	`Identifier, PatchDocument, region`
`list_resources`	`db_cluster_parameter_groups_list_only`	`SELECT`	`region`
`get_resource`	`db_cluster_parameter_groups`	`SELECT`	`Identifier, region`

`SELECT` examples

get (all properties)
list (identifiers only)

Gets all properties from an individual db_cluster_parameter_group.

SELECT
  region,
  description,
  family,
  parameters,
  db_cluster_parameter_group_name,
  tags
FROM awscc.rds.db_cluster_parameter_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ db_cluster_parameter_group_name }}';

Lists all db_cluster_parameter_groups in a region.

SELECT
  region,
  db_cluster_parameter_group_name
FROM awscc.rds.db_cluster_parameter_groups_list_only
WHERE
  region = 'us-east-1';

`INSERT` example

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

Required Properties
All Properties
Manifest

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

/*+ create */
INSERT INTO awscc.rds.db_cluster_parameter_groups (
  Description,
  Family,
  Parameters,
  DBClusterParameterGroupName,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ family }}',
  '{{ parameters }}',
  '{{ db_cluster_parameter_group_name }}',
  '{{ tags }}',
  '{{ region }}';

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: db_cluster_parameter_group_name
        value: '{{ db_cluster_parameter_group_name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

`UPDATE` example

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

/*+ update */
UPDATE awscc.rds.db_cluster_parameter_groups
SET PatchDocument = string('{{ {
    "Parameters": parameters,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ db_cluster_parameter_group_name }}';

`DELETE` example

/*+ delete */
DELETE FROM awscc.rds.db_cluster_parameter_groups
WHERE
  Identifier = '{{ db_cluster_parameter_group_name }}' AND
  region = 'us-east-1';

Permissions

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

Create
Read
Update
Delete
List

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

rds:DescribeDBClusterParameterGroups,
rds:DescribeDBClusterParameters,
rds:ListTagsForResource

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

rds:DeleteDBClusterParameterGroup

rds:DescribeDBClusterParameterGroups

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​

Permissions​