AWS::RDS::DBParameterGroup - AWS CloudFormation

AWS::RDS::DBParameterGroup

The AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.

This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.

For information about configuring parameters for Amazon RDS DB instances, see Working with DB parameter groups in the Amazon RDS User Guide.

For information about configuring parameters for Amazon Aurora DB instances, see Working with DB parameter groups and DB cluster parameter groups in the Amazon Aurora User Guide.

Note

Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.

Syntax

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

JSON

{ "Type" : "AWS::RDS::DBParameterGroup", "Properties" : { "Description" : String, "Family" : String, "Parameters" : {Key : Value, ...}, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::RDS::DBParameterGroup Properties: Description: String Family: String Parameters: Key : Value Tags: - Tag

Properties

Description

Provides the customer-specified description for this DB Parameter Group.

Required: Yes

Type: String

Update requires: No interruption

Family

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.

Note

The DB parameter group family can't be changed when updating a DB 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 CreateDBParameterGroup.

Required: Yes

Type: String

Update requires: No interruption

Parameters

An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. You can modify a maximum of 20 parameters in a single request.

For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide.

For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster Parameter Groups in the Amazon Aurora User Guide.

Note

AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

Required: No

Type: Map of String

Update requires: No interruption

Tags

Tags to assign to the DB 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 parameter group.

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

Examples

The following example creates a parameter group for a MySQL DB instance and sets the sql_mode, max_allowed_packet, and innodb_buffer_pool_size parameters.

JSON

"RDSDBParameterGroup": { "Type": "AWS::RDS::DBParameterGroup", "Properties": { "Description": "CloudFormation Sample MySQL Parameter Group", "Family": "mysql8.0", "Parameters": { "sql_mode": "IGNORE_SPACE", "max_allowed_packet": 1024, "innodb_buffer_pool_size": "{DBInstanceClassMemory*3/4}" } } }

YAML

RDSDBParameterGroup: Type: 'AWS::RDS::DBParameterGroup' Properties: Description: CloudFormation Sample MySQL Parameter Group Family: mysql8.0 Parameters: sql_mode: IGNORE_SPACE max_allowed_packet: 1024 innodb_buffer_pool_size: '{DBInstanceClassMemory*3/4}'