Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Relational Database Service Resource Types Reference » AWS::RDS::DBClusterParameterGroup

AWS::RDS::DBClusterParameterGroup

The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon Relational Database Service (Amazon RDS) database (DB) cluster parameter group. For more information about DB cluster parameter groups, see Appendix: DB Cluster and DB Instance Parameters in the Amazon RDS User Guide.

Note

Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::RDS::DBClusterParameterGroup",
  "Properties" : {
    "Description" : String,
    "Family" : String,
    "Parameters" : DBParameters,
    "Tags" : [ Resource Tag, ... ]
  }
}

YAML

Type: "AWS::RDS::DBClusterParameterGroup"
Properties: 
  Description: String
  Family: String
  Parameters: DBParameters
  Tags:
    Resource Tag

Properties

Description

A friendly description for this DB cluster parameter group.

Required: Yes

Type: String

Update requires: Replacement

Family

The database family of this DB cluster parameter group, such as aurora5.6.

Required: Yes

Type: String

Update requires: Replacement

Parameters

The parameters to set for this DB cluster parameter group. For a list of parameter keys, see Appendix: DB Cluster and DB Instance Parameters in the Amazon RDS User Guide.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance that is associated with the parameter group before the change can take effect.

Required: Yes

Type: A JSON object consisting of string key-value pairs, as shown in the following example: 

"Parameters" : {
   "Key1" : "Value1",
   "Key2" : "Value2",
   "Key3" : "Value3"
}

Update requires: No interruption or some interruptions, depending on the parameters that you update.

Tags

The tags that you want to attach to this parameter group.

Required: No

Type: A list of resource tags

Update requires: No interruption

Return Values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Example

The following snippet creates a parameter group that sets the character set database to UTF32:

JSON

"RDSDBClusterParameterGroup" : {
  "Type" : "AWS::RDS::DBClusterParameterGroup",
  "Properties" : {
    "Parameters" : {
      "character_set_database" : "utf32"
    },
    "Family" : "aurora5.6",
    "Description" : "A sample parameter group"
  }
}

YAML

RDSDBClusterParameterGroup: 
  Type: "AWS::RDS::DBClusterParameterGroup"
  Properties: 
    Parameters: 
      character_set_database: "utf32"
    Family: "aurora5.6"
    Description: "A sample parameter group"