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 cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management 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 BeginRestoreFromClusterSnapshot and EndRestoreFromClusterSnapshot.

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

Syntax

C#
public abstract Task<RestoreFromClusterSnapshotResponse> RestoreFromClusterSnapshotAsync(
         RestoreFromClusterSnapshotRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Redshift.Model.RestoreFromClusterSnapshotRequest

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

Exceptions

ExceptionCondition
AccessToSnapshotDeniedException The owner of the specified snapshot has not authorized your account to access the snapshot.
ClusterAlreadyExistsException The account already has a cluster with the given identifier.
ClusterParameterGroupNotFoundException The parameter group name does not refer to an existing parameter group.
ClusterQuotaExceededException The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
ClusterSecurityGroupNotFoundException The cluster security group name does not refer to an existing cluster security group.
ClusterSnapshotNotFoundException The snapshot identifier does not refer to an existing cluster snapshot.
ClusterSubnetGroupNotFoundException The cluster subnet group name does not refer to an existing cluster subnet group.
DependentServiceRequestThrottlingException The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
DependentServiceUnavailableException Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
HsmClientCertificateNotFoundException There is no Amazon Redshift HSM client certificate with the specified identifier.
HsmConfigurationNotFoundException There is no Amazon Redshift HSM configuration with the specified identifier.
InsufficientClusterCapacityException The number of nodes specified exceeds the allotted capacity of the cluster.
InvalidClusterSnapshotStateException The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.
InvalidClusterSubnetGroupStateException The cluster subnet group cannot be deleted because it is in use.
InvalidClusterTrackException The provided cluster track name is not valid.
InvalidElasticIpException The Elastic IP (EIP) is invalid or cannot be found.
InvalidReservedNodeStateException Indicates that the Reserved Node being exchanged is not in an active state.
InvalidRestoreException The restore is invalid.
InvalidSubnetException The requested subnet is not valid, or not all of the subnets are in the same VPC.
InvalidTagException The tag is invalid.
InvalidVPCNetworkStateException The cluster subnet group does not cover all Availability Zones.
Ipv6CidrBlockNotFoundException There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
LimitExceededException The encryption key has exceeded its grant limit in Amazon Web Services KMS.
NumberOfNodesPerClusterLimitExceededException The operation would exceed the number of nodes allowed for a cluster.
NumberOfNodesQuotaExceededException The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
ReservedNodeAlreadyExistsException User already has a reservation with the given identifier.
ReservedNodeAlreadyMigratedException Indicates that the reserved node has already been exchanged.
ReservedNodeNotFoundException The specified reserved compute node not found.
ReservedNodeOfferingNotFoundException Specified offering does not exist.
SnapshotScheduleNotFoundException We could not find the specified snapshot schedule.
TagLimitExceededException You have exceeded the number of tags allowed.
UnauthorizedOperationException Your account is not authorized to perform the requested operation.
UnsupportedOperationException The requested operation isn't supported.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also