CreateClusterSnapshot - Amazon DocumentDB


Creates a snapshot of an elastic cluster.

Request Syntax

POST /cluster-snapshot HTTP/1.1 Content-type: application/json { "clusterArn": "string", "snapshotName": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The ARN identifier of the elastic cluster of which you want to create a snapshot.

Type: String

Required: Yes


The name of the new elastic cluster snapshot.

Type: String

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

Required: Yes


The tags to be assigned to the new 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 the new 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: