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 CopyDBClusterSnapshot operation. Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptune.AmazonNeptuneRequest
      Amazon.Neptune.Model.CopyDBClusterSnapshotRequest

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

Syntax

C#
public class CopyDBClusterSnapshotRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest, IPreSignedUrlRequest

The CopyDBClusterSnapshotRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CopyTags System.Boolean

Gets and sets the property CopyTags.

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Public Property PreSignedUrl System.String

Gets and sets the property PreSignedUrl.

Not currently supported.

Public Property SourceDBClusterSnapshotIdentifier System.String

Gets and sets the property SourceDBClusterSnapshotIdentifier.

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

  • Must specify a valid system snapshot in the "available" state.

  • Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

Public Property SourceRegion System.String

The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client.

Public Property Tags System.Collections.Generic.List<Amazon.Neptune.Model.Tag>

Gets and sets the property Tags.

The tags to assign to the new DB cluster snapshot copy.

Public Property TargetDBClusterSnapshotIdentifier System.String

Gets and sets the property TargetDBClusterSnapshotIdentifier.

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

Examples

The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.

To copy a DB cluster snapshot


var response = client.CopyDBClusterSnapshot(new CopyDBClusterSnapshotRequest 
{
    SourceDBClusterSnapshotIdentifier = "rds:sample-cluster-2016-09-14-10-38",
    TargetDBClusterSnapshotIdentifier = "cluster-snapshot-copy-1"
});

DBClusterSnapshot dbClusterSnapshot = response.DBClusterSnapshot;

            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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