class Aws::RDS::Types::CopyDBClusterSnapshotMessage

@note When making an API call, you may pass CopyDBClusterSnapshotMessage

data as a 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",
        },
      ],
      source_region: "String",
    }

@!attribute [rw] source_db_cluster_snapshot_identifier

The identifier of the DB cluster snapshot to copy. This parameter
isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one
Amazon Web Services Region to another.

Constraints:

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

* If the source snapshot is in the same Amazon Web Services Region
  as the copy, specify a valid DB snapshot identifier.

* If the source snapshot is in a different Amazon Web Services
  Region than the copy, specify a valid DB cluster snapshot ARN. For
  more information, go to [ Copying Snapshots Across Amazon Web
  Services Regions][1] in the *Amazon Aurora User Guide.*

Example: `my-cluster-snapshot1`

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions
@return [String]

@!attribute [rw] target_db_cluster_snapshot_identifier

The identifier of the new DB cluster snapshot to create from the
source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

* First character must be a letter.

* Can't end with a hyphen or contain two consecutive hyphens.

Example: `my-cluster-snapshot2`
@return [String]

@!attribute [rw] kms_key_id

The Amazon Web Services KMS key identifier for an encrypted DB
cluster snapshot. The Amazon Web Services KMS key identifier is the
key ARN, key ID, alias ARN, or alias name for the Amazon Web
Services KMS customer master key (CMK).

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

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

To copy an encrypted DB cluster snapshot to another Amazon Web
Services Region, you must set `KmsKeyId` to the Amazon Web Services
KMS key identifier you want to use to encrypt the copy of the DB
cluster snapshot in the destination Amazon Web Services Region.
Amazon Web Services KMS CMKs are specific to the Amazon Web Services
Region that they are created in, and you can't use CMKs from one
Amazon Web Services Region in another Amazon Web Services Region.

If you copy an unencrypted DB cluster snapshot and specify a value
for the `KmsKeyId` parameter, an error is returned.
@return [String]

@!attribute [rw] pre_signed_url

The URL that contains a Signature Version 4 signed request for the
`CopyDBClusterSnapshot` API action in the Amazon Web Services Region
that contains the source DB cluster snapshot to copy. The
`PreSignedUrl` parameter must be used when copying an encrypted DB
cluster snapshot from another Amazon Web Services Region. Don't
specify `PreSignedUrl` when you are copying an encrypted DB cluster
snapshot in the same Amazon Web Services Region.

The pre-signed URL must be a valid request for the
`CopyDBClusterSnapshot` API action that can be executed in the
source Amazon Web Services Region that contains the encrypted DB
cluster snapshot to be copied. The pre-signed URL request must
contain the following parameter values:

* `KmsKeyId` - The Amazon Web Services KMS key identifier for the
  customer master key (CMK) to use to encrypt the copy of the DB
  cluster snapshot in the destination Amazon Web Services Region.
  This is the same identifier for both the `CopyDBClusterSnapshot`
  action that is called in the destination Amazon Web Services
  Region, and the action contained in the pre-signed URL.

* `DestinationRegion` - The name of the Amazon Web Services Region
  that the DB cluster snapshot is to be created in.

* `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
  identifier for the encrypted DB cluster snapshot to be copied.
  This identifier must be in the Amazon Resource Name (ARN) format
  for the source Amazon Web Services Region. For example, if you are
  copying an encrypted DB cluster snapshot from the us-west-2 Amazon
  Web Services Region, then your `SourceDBClusterSnapshotIdentifier`
  looks like the following example:
  `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115`.

To learn how to generate a Signature Version 4 signed request, see [
Authenticating Requests: Using Query Parameters (Amazon Web Services
Signature Version 4)][1] and [ Signature Version 4 Signing
Process][2].

<note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
specify `SourceRegion` (or `--source-region` for the CLI) instead of
specifying `PreSignedUrl` manually. Specifying `SourceRegion`
autogenerates a pre-signed URL that is a valid request for the
operation that can be executed in the source Amazon Web Services
Region.

 </note>

[1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
[2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
@return [String]

@!attribute [rw] copy_tags

A value that indicates whether to copy all tags from the source DB
cluster snapshot to the target DB cluster snapshot. By default, tags
are not copied.
@return [Boolean]

@!attribute [rw] tags

A list of tags. For more information, see [Tagging Amazon RDS
Resources][1] in the *Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
@return [Array<Types::Tag>]

@!attribute [rw] source_region

The source region of the snapshot. This is only needed when the
shapshot is encrypted and in a different region.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CopyDBClusterSnapshotMessage AWS API Documentation

Constants

SENSITIVE