RestoreDBClusterFromSnapshotCommand

Suggest an Edit

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, RestoreDBClusterFromSnapshotCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, RestoreDBClusterFromSnapshotCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // RestoreDBClusterFromSnapshotMessage
  AvailabilityZones: [ // AvailabilityZones
    "STRING_VALUE",
  ],
  DBClusterIdentifier: "STRING_VALUE", // required
  SnapshotIdentifier: "STRING_VALUE", // required
  Engine: "STRING_VALUE", // required
  EngineVersion: "STRING_VALUE",
  Port: Number("int"),
  DBSubnetGroupName: "STRING_VALUE",
  VpcSecurityGroupIds: [ // VpcSecurityGroupIdList
    "STRING_VALUE",
  ],
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
  KmsKeyId: "STRING_VALUE",
  EnableCloudwatchLogsExports: [ // LogTypeList
    "STRING_VALUE",
  ],
  DeletionProtection: true || false,
  DBClusterParameterGroupName: "STRING_VALUE",
  StorageType: "STRING_VALUE",
};
const command = new RestoreDBClusterFromSnapshotCommand(input);
const response = await client.send(command);
// { // RestoreDBClusterFromSnapshotResult
//   DBCluster: { // DBCluster
//     AvailabilityZones: [ // AvailabilityZones
//       "STRING_VALUE",
//     ],
//     BackupRetentionPeriod: Number("int"),
//     DBClusterIdentifier: "STRING_VALUE",
//     DBClusterParameterGroup: "STRING_VALUE",
//     DBSubnetGroup: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     PercentProgress: "STRING_VALUE",
//     EarliestRestorableTime: new Date("TIMESTAMP"),
//     Endpoint: "STRING_VALUE",
//     ReaderEndpoint: "STRING_VALUE",
//     MultiAZ: true || false,
//     Engine: "STRING_VALUE",
//     EngineVersion: "STRING_VALUE",
//     LatestRestorableTime: new Date("TIMESTAMP"),
//     Port: Number("int"),
//     MasterUsername: "STRING_VALUE",
//     PreferredBackupWindow: "STRING_VALUE",
//     PreferredMaintenanceWindow: "STRING_VALUE",
//     ReplicationSourceIdentifier: "STRING_VALUE",
//     ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
//       "STRING_VALUE",
//     ],
//     DBClusterMembers: [ // DBClusterMemberList
//       { // DBClusterMember
//         DBInstanceIdentifier: "STRING_VALUE",
//         IsClusterWriter: true || false,
//         DBClusterParameterGroupStatus: "STRING_VALUE",
//         PromotionTier: Number("int"),
//       },
//     ],
//     VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
//       { // VpcSecurityGroupMembership
//         VpcSecurityGroupId: "STRING_VALUE",
//         Status: "STRING_VALUE",
//       },
//     ],
//     HostedZoneId: "STRING_VALUE",
//     StorageEncrypted: true || false,
//     KmsKeyId: "STRING_VALUE",
//     DbClusterResourceId: "STRING_VALUE",
//     DBClusterArn: "STRING_VALUE",
//     AssociatedRoles: [ // DBClusterRoles
//       { // DBClusterRole
//         RoleArn: "STRING_VALUE",
//         Status: "STRING_VALUE",
//       },
//     ],
//     CloneGroupId: "STRING_VALUE",
//     ClusterCreateTime: new Date("TIMESTAMP"),
//     EnabledCloudwatchLogsExports: [ // LogTypeList
//       "STRING_VALUE",
//     ],
//     DeletionProtection: true || false,
//     StorageType: "STRING_VALUE",
//     MasterUserSecret: { // ClusterMasterUserSecret
//       SecretArn: "STRING_VALUE",
//       SecretStatus: "STRING_VALUE",
//       KmsKeyId: "STRING_VALUE",
//     },
//   },
// };

RestoreDBClusterFromSnapshotCommand Input

See RestoreDBClusterFromSnapshotCommandInput for more details

Parameter
Type
Description
DBClusterIdentifier
Required
string | undefined

The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.

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-snapshot-id

Engine
Required
string | undefined

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

SnapshotIdentifier
Required
string | undefined

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

AvailabilityZones
string[] | undefined

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

DBClusterParameterGroupName
string | undefined

The name of the DB cluster parameter group to associate with this DB cluster.

Type: String. Required: No.

If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

DBSubnetGroupName
string | undefined

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

DeletionProtection
boolean | undefined

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

EnableCloudwatchLogsExports
string[] | undefined

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

EngineVersion
string | undefined

The version of the database engine to use for the new cluster.

KmsKeyId
string | undefined

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.

  • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Port
number | undefined

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

StorageType
string | undefined

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

Tags
Tag[] | undefined

The tags to be assigned to the restored cluster.

VpcSecurityGroupIds
string[] | undefined

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

RestoreDBClusterFromSnapshotCommand Output

See RestoreDBClusterFromSnapshotCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DBCluster
DBCluster | undefined

Detailed information about a cluster.

Throws

Name
Fault
Details
DBClusterAlreadyExistsFault
client

You already have a cluster with the given identifier.

DBClusterQuotaExceededFault
client

The cluster can't be created because you have reached the maximum allowed quota of clusters.

DBClusterSnapshotNotFoundFault
client

DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

DBSnapshotNotFoundFault
client

DBSnapshotIdentifier doesn't refer to an existing snapshot.

DBSubnetGroupNotFoundFault
client

DBSubnetGroupName doesn't refer to an existing subnet group.

InsufficientDBClusterCapacityFault
client

The cluster doesn't have enough capacity for the current operation.

InsufficientStorageClusterCapacityFault
client

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

InvalidDBClusterSnapshotStateFault
client

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

InvalidDBSnapshotStateFault
client

The state of the snapshot doesn't allow deletion.

InvalidRestoreFault
client

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

InvalidSubnet
client

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

InvalidVPCNetworkStateFault
client

The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

KMSKeyNotAccessibleFault
client

An error occurred when accessing an KMS key.

StorageQuotaExceededFault
client

The request would cause you to exceed the allowed amount of storage available across all instances.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.