ModifyDBClusterParameterGroup
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter,
submit a list of the following: ParameterName, ParameterValue,
and ApplyMethod. A maximum of 20
parameters can be modified in a single request.
Important
After you create a DB cluster parameter group, you should wait at least 5 minutes
before creating your first DB cluster that uses that DB cluster parameter group as the default parameter
group. This allows Amazon RDS to fully complete the create operation before the parameter
group is used as the default for a new DB cluster. This is especially important for parameters
that are critical when creating the default database for a DB cluster, such as the character set
for the default database defined by the character_set_database parameter. You can use the
Parameter Groups option of the Amazon RDS consoleDescribeDBClusterParameters operation to verify
that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBClusterParameterGroupName
-
The name of the DB cluster parameter group to modify.
Type: String
Required: Yes
- Parameters.Parameter.N
-
A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method):
immediate | pending-rebootNote
You can use the
immediatevalue with dynamic parameters only. You can use thepending-rebootvalue for both dynamic and static parameters.When the application method is
immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method ispending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.Type: Array of Parameter objects
Required: Yes
Response Elements
The following element is returned by the service.
- DBClusterParameterGroupName
-
The name of the DB cluster parameter group.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter
-
Can't end with a hyphen or contain two consecutive hyphens
Note
This value is stored as a lowercase string.
Type: String
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBParameterGroupNotFound
-
DBParameterGroupNamedoesn't refer to an existing DB parameter group.HTTP Status Code: 404
- InvalidDBParameterGroupState
-
The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ModifyDBClusterParameterGroup.
Sample Request
https://rds.us-west-2.amazonaws.com/
?Action=ModifyDBClusterParameterGroup
&DBClusterParameterGroupName=sample-cluster-pg
&Parameters.member.1.ApplyMethod=pending-reboot
&Parameters.member.1.ParameterName=binlog_format
&Parameters.member.1.ParameterValue=MIXED
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-10-31
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20160913/us-west-2/rds/aws4_request
&X-Amz-Date=20160913T173245Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=cfb4f35de32455f77405636315dd431f2e236a1a997f94e0f6e00183d1f5156eSample Response
<ModifyDBClusterParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
<ModifyDBClusterParameterGroupResult>
<DBClusterParameterGroupName>sample-cluster-pg</DBClusterParameterGroupName>
</ModifyDBClusterParameterGroupResult>
<ResponseMetadata>
<RequestId>1534d6a1-79d8-11e6-9b94-838991bd50c6</RequestId>
</ResponseMetadata>
</ModifyDBClusterParameterGroupResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
