Request Parameters Response Elements Errors Examples See Also

CreateDBParameterGroup

Creates a new 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 ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

This command doesn't apply to RDS Custom.

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 DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBParameterGroupFamily

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

To list all of the available parameter group families for a DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

Note

The output contains duplicates.

The following are the valid DB engine values:

aurora-mysql
aurora-postgresql
db2-ae
db2-se
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web

Type: String

Required: Yes

DBParameterGroupName

The name of the DB parameter group.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
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

Required: Yes

Description

The description for the DB parameter group.

Type: String

Required: Yes

Tags.Tag.N

Tags to assign to the DB parameter group.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

DBParameterGroup

Contains the details of an Amazon RDS DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

Type: DBParameterGroup object

Errors

For information about the errors that are common to all actions, see Common Errors.

DBParameterGroupAlreadyExists

A DB parameter group with the same name exists.

HTTP Status Code: 400

DBParameterGroupQuotaExceeded

The request would result in the user exceeding the allowed number of DB parameter groups.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateDBParameterGroup.

Sample Request



https://rds.us-east-1.amazonaws.com/
   ?Action=CreateDBParameterGroup
   &DBParameterGroupFamily=MySQL5.1
   &DBParameterGroupName=mydbparamgroup3
   &Description=My%20new%20DB%20Parameter%20Group
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140423/us-east-1/rds/aws4_request
   &X-Amz-Date=20140423T201938Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=e9e5e723f627e872e8bccdc6ccc60bdffcf4a32ae6758ef0a3717ffae49097ae

Sample Response



<CreateDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <CreateDBParameterGroupResult>
    <DBParameterGroup>
      <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
      <Description>My new DB Parameter Group</Description>
      <DBParameterGroupName>mydbparamgroup3</DBParameterGroupName>
    </DBParameterGroup>
  </CreateDBParameterGroupResult>
  <ResponseMetadata>
    <RequestId>7805c127-af22-11c3-96ac-6999cc5f7e72</RequestId>
  </ResponseMetadata>
</CreateDBParameterGroupResponse>