Class: Aws::RDS::Types::CopyDBClusterSnapshotMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_tagsBoolean

Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

Returns:

  • (Boolean)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-rds/types.rb', line 1355

class CopyDBClusterSnapshotMessage < Struct.new(
  :source_db_cluster_snapshot_identifier,
  :target_db_cluster_snapshot_identifier,
  :kms_key_id,
  :pre_signed_url,
  :copy_tags,
  :tags,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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 key.

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 KMS 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 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. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can’t use KMS keys 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.

Returns:

  • (String)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-rds/types.rb', line 1355

class CopyDBClusterSnapshotMessage < Struct.new(
  :source_db_cluster_snapshot_identifier,
  :target_db_cluster_snapshot_identifier,
  :kms_key_id,
  :pre_signed_url,
  :copy_tags,
  :tags,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#pre_signed_urlString

When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the ‘CopyDBClusterSnapshot` API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the `PreSignedUrl` parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don’t specify ‘PreSignedUrl` when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

This setting applies only to Amazon Web Services GovCloud (US) Regions. It’s ignored in other Amazon Web Services Regions.

The presigned URL must be a valid request for the ‘CopyDBClusterSnapshot` API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

  • ‘KmsKeyId` - The KMS key identifier for the KMS key 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` operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned 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)] and [ Signature Version 4 Signing Process].

<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 presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

</note>

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

Returns:

  • (String)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-rds/types.rb', line 1355

class CopyDBClusterSnapshotMessage < Struct.new(
  :source_db_cluster_snapshot_identifier,
  :target_db_cluster_snapshot_identifier,
  :kms_key_id,
  :pre_signed_url,
  :copy_tags,
  :tags,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_cluster_snapshot_identifierString

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] in the *Amazon Aurora User Guide*.

Example: ‘my-cluster-snapshot1`

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

Returns:

  • (String)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-rds/types.rb', line 1355

class CopyDBClusterSnapshotMessage < Struct.new(
  :source_db_cluster_snapshot_identifier,
  :target_db_cluster_snapshot_identifier,
  :kms_key_id,
  :pre_signed_url,
  :copy_tags,
  :tags,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#source_regionString

The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.

Returns:

  • (String)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-rds/types.rb', line 1355

class CopyDBClusterSnapshotMessage < Struct.new(
  :source_db_cluster_snapshot_identifier,
  :target_db_cluster_snapshot_identifier,
  :kms_key_id,
  :pre_signed_url,
  :copy_tags,
  :tags,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-rds/types.rb', line 1355

class CopyDBClusterSnapshotMessage < Struct.new(
  :source_db_cluster_snapshot_identifier,
  :target_db_cluster_snapshot_identifier,
  :kms_key_id,
  :pre_signed_url,
  :copy_tags,
  :tags,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end

#target_db_cluster_snapshot_identifierString

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`

Returns:

  • (String)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/aws-sdk-rds/types.rb', line 1355

class CopyDBClusterSnapshotMessage < Struct.new(
  :source_db_cluster_snapshot_identifier,
  :target_db_cluster_snapshot_identifier,
  :kms_key_id,
  :pre_signed_url,
  :copy_tags,
  :tags,
  :source_region)
  SENSITIVE = []
  include Aws::Structure
end