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 an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide.

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 RestoreDBClusterFromS3 operation has completed and the DB cluster is available.

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

This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.

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 BeginRestoreDBClusterFromS3 and EndRestoreDBClusterFromS3.

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

Syntax

C#
public virtual Task<RestoreDBClusterFromS3Response> RestoreDBClusterFromS3Async(
         RestoreDBClusterFromS3Request request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.RestoreDBClusterFromS3Request

Container for the necessary parameters to execute the RestoreDBClusterFromS3 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 RestoreDBClusterFromS3 service method, as returned by RDS.

Exceptions

ExceptionCondition
DBClusterAlreadyExistsException The user already has a DB cluster with the given identifier.
DBClusterNotFoundException DBClusterIdentifier doesn't refer to an existing DB cluster.
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.
DBSubnetGroupNotFoundException DBSubnetGroupName doesn't refer to an existing DB subnet group.
DomainNotFoundException Domain doesn't refer to an existing Active Directory domain.
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.
InvalidDBClusterStateException The requested operation can't be performed while the cluster is in this state.
InvalidDBSubnetGroupStateException The DB subnet group cannot be deleted because it's in use.
InvalidS3BucketException The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.
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.
StorageQuotaExceededException The request would result in the user exceeding the allowed amount of storage available across all DB instances.
StorageTypeNotSupportedException The specified StorageType can't be associated with the DB instance.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also