Amazon DocumentDB
Developer Guide

CreateDBClusterSnapshot

Creates a snapshot of a DB cluster.

Request Parameters

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

DBClusterIdentifier

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

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster

Type: String

Required: Yes

DBClusterSnapshotIdentifier

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

Constraints:

  • 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

Tags.Tag.N

The tags to be assigned to the DB cluster snapshot.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

DBClusterSnapshot

Detailed information about a DB cluster snapshot.

Type: DBClusterSnapshot object

Errors

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

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

DBClusterSnapshotAlreadyExistsFault

You already have a DB cluster snapshot with the given identifier.

HTTP Status Code: 400

InvalidDBClusterSnapshotStateFault

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

HTTP Status Code: 400

InvalidDBClusterStateFault

The DB cluster isn't in a valid state.

HTTP Status Code: 400

SnapshotQuotaExceeded

The request would cause you to exceed the allowed number of DB 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: