Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14198183.8 KB

Restores an elastic cluster from a snapshot.

post/cluster-snapshot/{snapshotArn}/restore

Path parameters

snapshotArnstring required

The ARN identifier of the elastic cluster snapshot.

Request body

clusterNamestring required

The name of the elastic cluster.

kmsKeyIdstring
<p>The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.</p> <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.</p> <p>If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.</p>
shardCapacityinteger

The capacity of each shard in the new restored elastic cluster.

shardInstanceCountinteger

The number of replica instances applying to all shards in the elastic cluster. A <code>shardInstanceCount</code> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

subnetIdsString[]

The Amazon EC2 subnet IDs for the elastic cluster.

tagsobject

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

vpcSecurityGroupIdsString[]

A list of EC2 VPC security groups to associate with the elastic cluster.

Response

Success