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.

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action 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 RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

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 BeginRestoreDBClusterToPointInTime and EndRestoreDBClusterToPointInTime.

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

Syntax

C#
public abstract Task<RestoreDBClusterToPointInTimeResponse> RestoreDBClusterToPointInTimeAsync(
         RestoreDBClusterToPointInTimeRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Neptune.Model.RestoreDBClusterToPointInTimeRequest

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

Exceptions

ExceptionCondition
DBClusterAlreadyExistsException User already has a DB cluster with the given identifier.
DBClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
DBClusterParameterGroupNotFoundException DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
DBClusterQuotaExceededException User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
DBClusterSnapshotNotFoundException DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
DBSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
InsufficientDBClusterCapacityException The DB cluster does not have enough capacity for the current operation.
InsufficientStorageClusterCapacityException 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.
InvalidDBClusterSnapshotStateException The supplied value is not a valid DB cluster snapshot state.
InvalidDBClusterStateException The DB cluster is not in a valid state.
InvalidDBSnapshotStateException The state of the DB snapshot does not 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 DB subnet group does not cover all Availability Zones after it is created because users' change.
KMSKeyNotAccessibleException Error accessing KMS key.
OptionGroupNotFoundException The designated option group could not be found.
StorageQuotaExceededException Request would result in 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