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

Class: Aws::DocDB::Types::CopyDBClusterSnapshotMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

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",
    },
  ],
}

Represents the input to CopyDBClusterSnapshot.

Instance Attribute Summary collapse

Instance Attribute Details

#copy_tagsBoolean

Set to 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)


416
417
418
419
420
421
422
423
424
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 416

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

#kms_key_idString

The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS 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 AWS 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 AWS 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.

To copy an encrypted DB cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the DB cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

Returns:

  • (String)


416
417
418
419
420
421
422
423
424
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 416

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

#pre_signed_urlString

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. You must use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another AWS Region.

The presigned URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will 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 AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115.

Returns:

  • (String)


416
417
418
419
420
421
422
423
424
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 416

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

#source_db_cluster_snapshot_identifierString

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

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

Constraints:

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

  • If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.

  • If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN.

Example: my-cluster-snapshot1

Returns:

  • (String)


416
417
418
419
420
421
422
423
424
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 416

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

#tagsArray<Types::Tag>

The tags to be assigned to the DB cluster snapshot.

Returns:



416
417
418
419
420
421
422
423
424
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 416

class CopyDBClusterSnapshotMessage < Struct.new(
  :source_db_cluster_snapshot_identifier,
  :target_db_cluster_snapshot_identifier,
  :kms_key_id,
  :pre_signed_url,
  :copy_tags,
  :tags)
  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 is not case sensitive.

Constraints:

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

  • The first character must be a letter.

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

Example: my-cluster-snapshot2

Returns:

  • (String)


416
417
418
419
420
421
422
423
424
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 416

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