AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.

This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterFromSnapshot operation has completed and the DB cluster is available.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRestoreDBClusterFromSnapshot and EndRestoreDBClusterFromSnapshot.

Namespace: Amazon.RDS
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<RestoreDBClusterFromSnapshotResponse> RestoreDBClusterFromSnapshotAsync(
         RestoreDBClusterFromSnapshotRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.RestoreDBClusterFromSnapshotRequest

Container for the necessary parameters to execute the RestoreDBClusterFromSnapshot service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the RestoreDBClusterFromSnapshot service method, as returned by RDS.

Exceptions

ExceptionCondition
DBClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
DBClusterParameterGroupNotFoundException DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.
DBClusterQuotaExceededException The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
DBClusterSnapshotNotFoundException DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.
DBSnapshotNotFoundException DBSnapshotIdentifier doesn't refer to an existing DB snapshot.
DBSubnetGroupDoesNotCoverEnoughAZsException Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
DBSubnetGroupNotFoundException DBSubnetGroupName doesn't refer to an existing DB subnet group.
DomainNotFoundException Domain doesn't refer to an existing Active Directory domain.
InsufficientDBClusterCapacityException The DB cluster doesn't have enough capacity for the current operation.
InsufficientDBInstanceCapacityException The specified DB instance class isn't available in the specified Availability Zone.
InsufficientStorageClusterCapacityException 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.
InvalidDBClusterSnapshotStateException The supplied value isn't a valid DB cluster snapshot state.
InvalidDBInstanceStateException The DB instance isn't in a valid state.
InvalidDBSnapshotStateException The state of the DB snapshot doesn't allow deletion.
InvalidRestoreException Cannot restore from VPC backup to non-VPC DB instance.
InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
InvalidVPCNetworkStateException The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
KMSKeyNotAccessibleException An error occurred accessing an Amazon Web Services KMS key.
OptionGroupNotFoundException The specified option group could not be found.
StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also