| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
AWS::RDS::DBParameterGroup
Creates a custom parameter group for an RDS database family. For more information about RDS parameter groups, see Working with DB Parameter Groups in the Amazon Relational Database Service User Guide.
This type can be declared in a template and referenced in the DBParameterGroupName
parameter of AWS::RDS::DBInstance.
Note
Applying a ParameterGroup to a DBInstance may require the instance to reboot, resulting in a database outage for the duration of the reboot.
Syntax
{
"Type": "AWS::RDS::DBParameterGroup",
"Properties" : {
"Description" : String,
"Family" : String,
"Parameters" : DBParameters
}
}Properties
- Description
A friendly description of the RDS parameter group. For example,
"My Parameter Group".Type: String
- Family
The database family of this RDS parameter group. For example,
"MySQL5.1".Type: String
- Parameters
The parameters to set for this RDS parameter group.
Type: DBParameters, a JSON object consisting of key/value pairs of Strings. For example:
"Parameters" : { "Key1" : "Value1", "Key2" : "Value2", "Key3" : "Value3" }
Return Values
Ref
When the logical ID of this resource is provided to the Ref intrinsic
function, it returns the resource name. For example:
{ "Ref": "MyDBParameterGroup" }For the RDS::DBParameterGroup with the logical ID "MyDBParameterGroup", Ref will
return the resource name.
For more information about using the Ref function, see Ref.
