CopyClusterSnapshot - Amazon DocumentDB


Copies a snapshot of an elastic cluster.

Request Syntax

POST /cluster-snapshot/snapshotArn/copy HTTP/1.1 Content-type: application/json { "copyTags": boolean, "kmsKeyId": "string", "tags": { "string" : "string" }, "targetSnapshotName": "string" }

URI Request Parameters

The request uses the following URI parameters.


The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

Required: Yes

Request Body

The request accepts the following data in JSON format.


The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.


  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: Yes


Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is false.

Type: Boolean

Required: No


The AWS KMS key ID for an encrypted elastic cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.

If you copy an encrypted elastic cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWSS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted with the same AWS KMS key as the source elastic cluster snapshot.

To copy an encrypted elastic cluster snapshot to another AWS region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. AWS KMS encryption keys are specific to the AWS region that they are created in, and you can't use encryption keys from one AWS region in another AWS region.

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Type: String

Required: No


The tags to be assigned to the elastic cluster snapshot.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Returns information about a specific elastic cluster snapshot.

Type: ClusterSnapshot object


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


An exception that occurs when there are not sufficient permissions to perform an action.

HTTP Status Code: 403


There was an access conflict.

HTTP Status Code: 409


There was an internal server error.

HTTP Status Code: 500


The specified resource could not be located.

HTTP Status Code: 404


The service quota for the action was exceeded.

HTTP Status Code: 402


ThrottlingException will be thrown when request was denied due to request throttling.

HTTP Status Code: 429


A structure defining a validation exception.

HTTP Status Code: 400

See Also

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