Amazon Relational Database Service
Command Line Interface Reference (API Version 2013-09-09)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

rds-modify-db-parameter-group

Description

Updates the parameters in a parameter group. You can update up to 20 values per call.

Note

Amazon RDS does not support passing multiple comma-delimited parameter values for a single parameter.

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 action 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 or the rds-describe-db-parameters command to verify that your DB parameter group has been created or modified.

Syntax

rds-modify-db-parameter-group DBParameterGroupName

-p (--parameters) "name=value, value=value, method=value"[,

"name=value, value=value, method=value"][,

...]

[General Options]

Options

NameDescriptionRequired

DBParameterGroupName

DB parameter group identifier. Stored as a lowercase string.

This value can also be passed using the --db-parameter-group-name named parameter.

Constraints: Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.

Yes

-p

--parameters "name=value, value=value, method=value"

A string containing a series of parameter names, values, and the update method for the parameter update. The first --parameters argument is required; subsequent arguments are optional. A maximum of 20 parameters may be updated in a single call to the rds-modify-parameter-group command.

To obtain a list of the parameters that make up a parameter group, with their values, use the rds-describe-db-parameters command. Only parameters that are marked as modifiable can be changed.

Valid values (method): immediate | pending-reboot.

If immediate, the change takes effect immediately. If pending-reboot, the change takes effect the next time that the DB instance is rebooted.

The immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB instances for either dynamic or static parameters. For Microsoft SQL Server DB instances, the pending-reboot parameter can be used only for static parameters.

Yes

Output

The command returns the following information:

Note

Output values list the possible values returned by CLI commands. Not all values are returned for every call to a command. If a value is null or empty, it will not be included in the command output. For example, CLI commands to create or restore a DB instance will not return the Endpoint Address value because that value is null until the DB instance has finished being created or restored.

  • Group Name—The name of the parameter group that was modified.

Examples

Modify Parameters in a Parameter Group

This example shows how to modify a group of parameters in a parameter group.

PROMPT> rds-modify-db-parameter-group mydbparametergroup --parameters "name=max_user_connections, value=24, method=pending-reboot" "name=max_allowed_packet, value=1024, method=immediate"