CopyDBClusterParameterGroup - Amazon Relational Database Service

CopyDBClusterParameterGroup

Copies the specified DB cluster parameter group.

Note

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

Request Parameters

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

SourceDBClusterParameterGroupIdentifier

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

Constraints:

  • Must specify a valid DB cluster parameter group.

Type: String

Required: Yes

TargetDBClusterParameterGroupDescription

A description for the copied DB cluster parameter group.

Type: String

Required: Yes

TargetDBClusterParameterGroupIdentifier

The identifier for the copied DB cluster 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-cluster-param-group1

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 or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

DBClusterParameterGroup

Contains the details of an Amazon RDS DB cluster parameter group.

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

Type: DBClusterParameterGroup 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 CopyDBClusterParameterGroup.

Sample Request

https://rds.us-east-1.amazonaws.com/ ?Action=CopyDBClusterParameterGroup &SignatureMethod=HmacSHA256 &SignatureVersion=4 &SourceDBClusterParameterGroupIdentifier=arn%3Aaws%3Ards%3Aus-east-1%3A815981987263%3cluster-pg%3Amy-cluster-pg &TargetDBParameterGroupIdentifier=new-cluster-pg &TargetDBParameterGroupDescription=New%20cluster%20group &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20160705/us-east-1/rds/aws4_request &X-Amz-Date=20160705T143101Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2

Sample Response

<CopyDBClusterParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <CreateDBClusterParameterGroupResult> <DBClusterParameterGroup> <DBParameterGroupFamily>aurora5.6</DBParameterGroupFamily> <Description>New cluster group</Description> <DBClusterParameterGroupName>new-cluster-pg</DBClusterParameterGroupName> </DBClusterParameterGroup> </CreateDBClusterParameterGroupResult> <ResponseMetadata> <RequestId>ae81a963-cd9d-11e4-8b88-8351746a4c92</RequestId> </ResponseMetadata> </CopyDBClusterParameterGroupResponse>

See Also

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