CopyDBParameterGroup - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

CopyDBParameterGroup

Copies the specified DB parameter group.

Note

You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.

Request Parameters

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

SourceDBParameterGroupIdentifier

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

Constraints:

  • Must specify a valid DB parameter group.

Type: String

Required: Yes

TargetDBParameterGroupDescription

A description for the copied DB parameter group.

Type: String

Required: Yes

TargetDBParameterGroupIdentifier

The identifier for the copied DB parameter group.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-parameter-group

Type: String

Required: Yes

Tags.Tag.N

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

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

DBParameterGroupNotFound

DBParameterGroupName doesn't refer to an existing DB parameter group.

HTTP Status Code: 404

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 CopyDBParameterGroup.

Sample Request

https://rds.us-east-1.amazonaws.com/ ?Action=CopyDBParameterGroup &SignatureMethod=HmacSHA256 &SignatureVersion=4 &SourceDBParameterGroupIdentifier=arn%3Aaws%3Ards%3Aus-west-2%3A815981987263%3pg%3Amy-remote-param-group &TargetDBParameterGroupIdentifier=new-local-param-group &TargetDBParameterGroupDescription=description &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request &X-Amz-Date=20140429T175351Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2

Sample Response

<CopyDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <CopyDBParameterGroupResult> <DBParameterGroup> <DBParameterGroupFamily>mysql5.6</DBParameterGroupFamily> <Description>description</Description> <DBParameterGroupName>new-local-param-group</DBParameterGroupName> </DBParameterGroup> </CopyDBParameterGroupResult> <ResponseMetadata> <RequestId>2928d60e-beb6-11d3-8e5c-3ccda5460c46</RequestId> </ResponseMetadata> </CopyDBParameterGroupResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: