Menu
Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)

rds-create-db-parameter-group

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Description

Creates a DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using rds-modify-db-parameter-group. Once you've created a DB parameter group, you need to associate it with your DB instance using rds-modify-db-instance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance for the new DB parameter group and associated settings to take effect.

Important

After you create 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 create 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-create-db-parameter-group db-parameter-group-name

-d (--description) value

-f (--db-parameter-group-family) value

[-tk (--tag-key) value ]

[-tv (--tag-value) value ]

[General Options]

Options

Name Description Required

--db-parameter-group-name value

The name for the DB parameter group.

This parameter is the default parameter and can be passed as the first value in the command and without a parameter name, for example: rds-create-db-parameter-group my-db-parameter-group-name.

Type: String

Default: None

Constraints: Is non-preserving and case-insensitive. Must contain visible characters only. Must be 1 to 63 alphanumeric characters or hyphens. Must not be "Default".

Example: --db-parameter-group-name mydbparametergroup

Yes

-d value

--description value

The description for the DB parameter group.

Type: String

Default: None

Constraints: Must not exceed 255 characters.

Example: -d "This is my parameter group"

Yes

-f value

--db-parameter-group-family value

The DB parameter group family. 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 database engine compatible with that DB parameter group family.

Type: String

Default: None

Example: -f MySQL5.1

Yes

--tag-key

-tk

The name of a tag to add for the new DB parameter group.

No

--tag-value

-tv

The value of the tag to add for the new DB parameter group.

No

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 user-supplied DB parameter group name

  • Parameter Group Family—Parameter group family to which this group applies.

  • Description—The description of the DB parameter group

Examples

Create a DB parameter group

This example creates a new DB parameter group.

Copy
PROMPT> rds-create-db-parameter-group mydbparametergroup -f mysql5.1 -d "My first DB parameter group" DBPARAMETERGROUP Group Name Parameter Group Family Description DBPARAMETERGROUP mydbparametergroup mysql5.1 My first DB parameter group