AWS::RDS::DBClusterParameterGroup
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 update stack waits until the DB cluster is started.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::RDS::DBClusterParameterGroup", "Properties" : { "DBClusterParameterGroupName" :
String
, "Description" :String
, "Family" :String
, "Parameters" :Json
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::RDS::DBClusterParameterGroup Properties: DBClusterParameterGroupName:
String
Description:String
Family:String
Parameters:Json
Tags:- Tag
Properties
DBClusterParameterGroupName
-
The name of the DB cluster parameter group.
Constraints:
-
Must not match the name of an existing DB cluster parameter group.
If you don't specify a value for
DBClusterParameterGroupName
property, a name is automatically created for the DB cluster parameter group.Note This value is stored as a lowercase string.
Required: No
Type: String
Update requires: Replacement
-
Description
-
A friendly description for this DB cluster parameter group.
Required: Yes
Type: String
Update requires: Replacement
Family
-
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 DB engine and engine version compatible with that DB cluster parameter group family.
Note The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.
To list all of the available parameter group families, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
The output contains duplicates.
For more information, see
CreateDBClusterParameterGroup
.Required: Yes
Type: String
Update requires: Replacement
Parameters
-
Provides a list of parameters for the DB cluster parameter group.
Required: Yes
Type: Json
Update requires: No interruption
Tags
-
An optional array of key-value pairs to apply to this DB cluster parameter group.
Required: No
Type: List of Tag
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the name of the DB cluster parameter group.
For more information about using the Ref
function, see Ref.
Examples
The following snippet creates a DB cluster parameter group for an Aurora MySQL DB cluster and
sets the time_zone
and character_set_database
parameters:
JSON
"RDSDBClusterParameterGroup": { "Type": "AWS::RDS::DBClusterParameterGroup", "Properties": { "Description": "CloudFormation Sample Aurora Cluster Parameter Group", "Family": "aurora5.6", "Parameters": { "time_zone": "US/Eastern", "character_set_database": "utf32" } } }
YAML
RDSDBClusterParameterGroup: Type: 'AWS::RDS::DBClusterParameterGroup' Properties: Description: CloudFormation Sample Aurora Cluster Parameter Group Family: aurora5.6 Parameters: time_zone: US/Eastern character_set_database: utf32