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.

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

Note:

For PCL this operation is only available in asynchronous form. Please refer to EnableSnapshotCopyAsync.

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

Syntax

C#
public virtual EnableSnapshotCopyResponse EnableSnapshotCopy(
         EnableSnapshotCopyRequest request
)
Parameters
request
Type: Amazon.Redshift.Model.EnableSnapshotCopyRequest

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

Return Value
The response from the EnableSnapshotCopy service method, as returned by Redshift.

Exceptions

ExceptionCondition
ClusterNotFoundException The ClusterIdentifier parameter does not refer to an existing cluster.
CopyToRegionDisabledException Cross-region snapshot copy was temporarily disabled. Try your request again.
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.
IncompatibleOrderableOptionsException The specified options are incompatible.
InvalidClusterStateException The specified cluster is not in the available state.
LimitExceededException The encryption key has exceeded its grant limit in AWS KMS.
SnapshotCopyAlreadyEnabledException The cluster already has cross-region snapshot copy enabled.
SnapshotCopyGrantNotFoundException The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
UnauthorizedOperationException Your account is not authorized to perform the requested operation.
UnknownSnapshotCopyRegionException The specified region is incorrect or does not exist.

Examples

This example enables snapshot copy for the cluster mycluster for region us-east-1.

To enable snapshot copy


var response = client.EnableSnapshotCopy(new EnableSnapshotCopyRequest 
{
    ClusterIdentifier = "mycluster",
    DestinationRegion = "us-east-1"
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also