ModifyDBParameterGroup
Modifies the parameters of a DB 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 modify a DB parameter group, you should wait at least 5 minutes
before creating your first DB instance that uses that DB parameter group as the default parameter
group. This allows Amazon RDS to fully complete the modify operation before the parameter
group is used as the default for a new DB instance. This is especially important for parameters
that are critical when creating the default database for a DB instance, 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 console
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBParameterGroupName
-
The name of the DB parameter group.
Constraints:
-
If supplied, must match the name of an existing
DBParameterGroup
.
Type: String
Required: Yes
-
- Parameters.Parameter.N
-
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method):
immediate | pending-reboot
You can use the
immediate
value with dynamic parameters only. You can use thepending-reboot
value for both dynamic and static parameters.When the application method is
immediate
, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.When the application method is
pending-reboot
, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.Note
You can't use
pending-reboot
with dynamic parameters on RDS for SQL Server DB instances. Useimmediate
.For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
Type: Array of Parameter objects
Required: Yes
Response Elements
The following element is returned by the service.
- DBParameterGroupName
-
The name of the DB parameter group.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBParameterGroupNotFound
-
DBParameterGroupName
doesn'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 ModifyDBParameterGroup.
Sample Request
https://rds.us-east-1.amazonaws.com/
?Action=ModifyDBParameterGroup
&DBParameterGroupName=mydbparametergroup01
&Parameters.member.1.ApplyMethod=immediate
&Parameters.member.1.ParameterName=binlog_cache_size
&Parameters.member.1.ParameterValue=65536
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-10-31
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20140425/us-east-1/rds/aws4_request
&X-Amz-Date=20140425T193811Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=afd9acfee876360dd294189465aca26502343d405292dc6e43b1961ad4d1d7e2
Sample Response
<ModifyDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
<ModifyDBParameterGroupResult>
<DBParameterGroupName>mydbparametergroup01</DBParameterGroupName>
</ModifyDBParameterGroupResult>
<ResponseMetadata>
<RequestId>12d7435e-bba0-11d3-fe11-33d33a9bb7e3</RequestId>
</ResponseMetadata>
</ModifyDBParameterGroupResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: