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

RestoreDBClusterFromSnapshot

Creates a new DB cluster from a DB cluster snapshot. 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 Aurora on Amazon RDS in the Amazon RDS 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 EC2 Availability Zones that instances in the restored DB cluster can be created in.

Type: Array of strings

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 cluster snapshot. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Type: String

Required: Yes

DBSubnetGroupName

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

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Type: String

Required: No

EnableIAMDatabaseAuthentication

A Boolean value that is 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

EngineVersion

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

Type: String

Required: No

KmsKeyId

The KMS key identifier to use when restoring an encrypted DB cluster from a 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 do not specify a value for the KmsKeyId parameter, then the following will occur:

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

  • If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.

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: Value must be 1150-65535

Default: The same port as the original DB cluster.

Type: Integer

Required: No

SnapshotIdentifier

The identifier for the DB cluster snapshot to restore from.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

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 result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBClusters action.

Type: DBCluster object

Errors

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

DBClusterAlreadyExistsFault

User already has a DB cluster with the given identifier.

HTTP Status Code: 400

DBClusterQuotaExceededFault

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 does not refer to an existing DB cluster snapshot.

HTTP Status Code: 404

DBSnapshotNotFound

DBSnapshotIdentifier does not refer to an existing DB snapshot.

HTTP Status Code: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName does not refer to an existing DB subnet group.

HTTP Status Code: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName does not refer to an existing DB subnet group.

HTTP Status Code: 404

InsufficientDBClusterCapacityFault

The DB cluster does not have enough capacity for the current operation.

HTTP Status Code: 403

InsufficientStorageClusterCapacity

There is insufficient storage available for the current action. You may 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 is not a valid DB cluster snapshot state.

HTTP Status Code: 400

InvalidDBSnapshotState

The state of the DB snapshot does not 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

DB subnet group does not cover all Availability Zones after it is created because users' change.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

Error accessing KMS key.

HTTP Status Code: 400

OptionGroupNotFoundFault

The specified option group could not be found.

HTTP Status Code: 404

StorageQuotaExceeded

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

HTTP Status Code: 400

StorageQuotaExceeded

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

HTTP Status Code: 400

Example

Sample Request

Copy
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

Copy
<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: