Amazon DocumentDB
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Creates a snapshot of a cluster.

Request Parameters

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


The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.


  • Must match the identifier of an existing DBCluster.

Example: my-cluster

Type: String

Required: Yes


The identifier of the cluster snapshot. This parameter is stored as a lowercase string.


  • 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: my-cluster-snapshot1

Type: String

Required: Yes


The tags to be assigned to the cluster snapshot.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.


Detailed information about a cluster snapshot.

Type: DBClusterSnapshot object


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


DBClusterIdentifier doesn't refer to an existing cluster.

HTTP Status Code: 404


You already have a cluster snapshot with the given identifier.

HTTP Status Code: 400


The provided value isn't a valid cluster snapshot state.

HTTP Status Code: 400


The cluster isn't in a valid state.

HTTP Status Code: 400


The request would cause you to exceed the allowed number of snapshots.

HTTP Status Code: 400

See Also

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