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 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)

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 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.

list (identifiers only)

Name	Datatype	Description
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.
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)

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 = '{{ region }}' AND
  Identifier = '{{ db_cluster_parameter_group_name }}';

list (identifiers only)

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 = '{{ region }}';

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 awscc.rds.db_cluster_parameter_groups (
  Description,
  Family,
  Parameters,
  region
)
SELECT
  '{{ description }}',
  '{{ family }}',
  '{{ parameters }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.rds.db_cluster_parameter_groups
WHERE
  Identifier = '{{ db_cluster_parameter_group_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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: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