Amazon Relational Database Service
API Reference (API Version 2014-10-31)

RestoreDBClusterFromSnapshot

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

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

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

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Request Parameters

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

AvailabilityZones.AvailabilityZone.N

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

Type: Array of strings

Required: No

BacktrackWindow

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Type: Long

Required: No

DatabaseName

The database name for the restored DB cluster.

Type: String

Required: No

DBClusterIdentifier

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Type: String

Required: Yes

DBClusterParameterGroupName

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Type: String

Required: No

DBSubnetGroupName

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

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Type: String

Required: No

DeletionProtection

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

Type: Boolean

Required: No

EnableCloudwatchLogsExports.member.N

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Type: Array of strings

Required: No

EnableIAMDatabaseAuthentication

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Type: Boolean

Required: No

Engine

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Type: String

Required: Yes

EngineMode

The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.

Type: String

Required: No

EngineVersion

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

Type: String

Required: No

KmsKeyId

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

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

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

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

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

Type: String

Required: No

OptionGroupName

The name of the option group to use for the restored DB cluster.

Type: String

Required: No

Port

The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Type: Integer

Required: No

ScalingConfiguration

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Type: ScalingConfiguration object

Required: No

SnapshotIdentifier

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

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

Constraints:

  • Must match the identifier of an existing Snapshot.

Type: String

Required: Yes

Tags.Tag.N

The tags to be assigned to the restored DB cluster.

Type: Array of Tag objects

Required: No

VpcSecurityGroupIds.VpcSecurityGroupId.N

A list of VPC security groups that the new DB cluster will belong to.

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

DBCluster

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

Type: DBCluster object

Errors

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

DBClusterAlreadyExistsFault

The user already has a DB cluster with the given identifier.

HTTP Status Code: 400

DBClusterParameterGroupNotFound

DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

HTTP Status Code: 404

DBClusterQuotaExceededFault

The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

HTTP Status Code: 403

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

HTTP Status Code: 404

DBSnapshotNotFound

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

HTTP Status Code: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName doesn't refer to an existing DB subnet group.

HTTP Status Code: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName doesn't refer to an existing DB subnet group.

HTTP Status Code: 404

InsufficientDBClusterCapacityFault

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

HTTP Status Code: 403

InsufficientStorageClusterCapacity

There is insufficient 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.

HTTP Status Code: 400

InvalidDBClusterSnapshotStateFault

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

HTTP Status Code: 400

InvalidDBSnapshotState

The state of the DB snapshot doesn't allow deletion.

HTTP Status Code: 400

InvalidRestoreFault

Cannot restore from VPC backup to non-VPC DB instance.

HTTP Status Code: 400

InvalidSubnet

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

HTTP Status Code: 400

InvalidVPCNetworkStateFault

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

An error occurred accessing an AWS KMS key.

HTTP Status Code: 400

OptionGroupNotFoundFault

The specified option group could not be found.

HTTP Status Code: 404

StorageQuotaExceeded

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

HTTP Status Code: 400

StorageQuotaExceeded

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

HTTP Status Code: 400

Example

Sample Request

https://rds.us-west-2.amazonaws.com/ ?Action=RestoreDBClusterFromSnapshot &DBClusterIdentifier=sample-restored &Engine=aurora &SignatureMethod=HmacSHA256 &SignatureVersion=4 &SnapshotIdentifier=sample-snapshot-1 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20160913/us-west-2/rds/aws4_request &X-Amz-Date=20160913T223701Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=65d0d03242d99a16ef3712142bfcd52ac63fd2f68fbb5efd7edfb1e89138da57

Sample Response

<RestoreDBClusterFromSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <RestoreDBClusterFromSnapshotResult> <DBCluster> <AllocatedStorage>1</AllocatedStorage> <DatabaseName>sample</DatabaseName> <AvailabilityZones> <AvailabilityZone>us-west-2a</AvailabilityZone> <AvailabilityZone>us-west-2b</AvailabilityZone> <AvailabilityZone>us-west-2c</AvailabilityZone> </AvailabilityZones> <PreferredBackupWindow>10:37-11:07</PreferredBackupWindow> <Endpoint>sample-restored.cluster-cnubrrevfka6.us-west-2.rds.amazonaws.com</Endpoint> <Engine>aurora</Engine> <ReaderEndpoint>sample-restored.cluster-ro-cnubrrevfka6.us-west-2.rds.amazonaws.com</ReaderEndpoint> <ReadReplicaIdentifiers/> <EngineVersion>5.6.10a</EngineVersion> <MasterUsername>mymasteruser</MasterUsername> <DBClusterMembers/> <StorageEncrypted>false</StorageEncrypted> <DBSubnetGroup>default</DBSubnetGroup> <VpcSecurityGroups> <VpcSecurityGroupMembership> <VpcSecurityGroupId>sg-178c1671</VpcSecurityGroupId> <Status>active</Status> </VpcSecurityGroupMembership> </VpcSecurityGroups> <HostedZoneId>Z1PVIF0B346C1W</HostedZoneId> <Port>3306</Port> <PreferredMaintenanceWindow>tue:11:51-tue:12:21</PreferredMaintenanceWindow> <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup> <BackupRetentionPeriod>1</BackupRetentionPeriod> <DBClusterIdentifier>sample-restored</DBClusterIdentifier> <DbClusterResourceId>cluster-BOCABDT6N5UVQW273AOXAX234Y</DbClusterResourceId> <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:sample-restored</DBClusterArn> <Status>creating</Status> </DBCluster> </RestoreDBClusterFromSnapshotResult> <ResponseMetadata> <RequestId>955ebc45-7a02-11e6-a5e1-0785f9b8437a</RequestId> </ResponseMetadata> </RestoreDBClusterFromSnapshotResponse>

See Also

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