You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Neptune::Types::CopyDBClusterSnapshotMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CopyDBClusterSnapshotMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  source_db_cluster_snapshot_identifier: "String", # required
  target_db_cluster_snapshot_identifier: "String", # required
  kms_key_id: "String",
  pre_signed_url: "String",
  copy_tags: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#copy_tags ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#kms_key_id ⇒ String

The AWS AWS 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 AWS 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 AWS account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the AWS Region that they are created in, and you can\'t use encryption keys from one AWS Region in another AWS 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.

Returns:

  • (String) —

    The AWS AWS KMS key ID for an encrypted DB cluster snapshot.

#pre_signed_url ⇒ String

Not currently supported.

Returns:

  • (String) —

    Not currently supported.

#source_db_cluster_snapshot_identifier ⇒ String

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

You can\'t copy from one AWS Region to another.

Constraints:

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

  • Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

Returns:

  • (String) —

    The identifier of the DB cluster snapshot to copy.

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

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

#target_db_cluster_snapshot_identifier ⇒ String

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

Returns:

  • (String) —

    The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot.