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.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Redshift.AmazonRedshiftRequest
      Amazon.Redshift.Model.EnableSnapshotCopyRequest

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

Syntax

C#
public class EnableSnapshotCopyRequest : AmazonRedshiftRequest
         IAmazonWebServiceRequest

The EnableSnapshotCopyRequest type exposes the following members

Constructors

NameDescription
Public Method EnableSnapshotCopyRequest()

Properties

NameTypeDescription
Public Property ClusterIdentifier System.String

Gets and sets the property ClusterIdentifier.

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

Public Property DestinationRegion System.String

Gets and sets the property DestinationRegion.

The destination Amazon Web Services Region that you want to copy snapshots to.

Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

Public Property ManualSnapshotRetentionPeriod System.Int32

Gets and sets the property ManualSnapshotRetentionPeriod.

The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

Public Property RetentionPeriod System.Int32

Gets and sets the property RetentionPeriod.

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default: 7.

Constraints: Must be at least 1 and no more than 35.

Public Property SnapshotCopyGrantName System.String

Gets and sets the property SnapshotCopyGrantName.

The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.

Examples

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

To enable snapshot copy


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


            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5