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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/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",
    },
  ],
  source_region: "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) 


805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-rds/types.rb', line 805

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

#destination_region ⇒ String

Returns:

  • (String) 


805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-rds/types.rb', line 805

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

#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`.

To copy an encrypted DB cluster snapshot to another AWS Region, you must set ‘KmsKeyId` to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. 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.

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

Returns:

  • (String) 


805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-rds/types.rb', line 805

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

#pre_signed_url ⇒ String

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. The `PreSignedUrl` parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region.

The pre-signed 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 pre-signed 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 pre-signed 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:aurora-cluster1-snapshot-20161115`.

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

[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) 


805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-rds/types.rb', line 805

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

#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 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. For more information, go to [ Copying Snapshots Across AWS 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) 


805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-rds/types.rb', line 805

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

#source_region ⇒ String

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

Returns:

  • (String) 


805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-rds/types.rb', line 805

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

#tags ⇒ Array<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:



805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-rds/types.rb', line 805

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

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

  • Can’t end with a hyphen or contain two consecutive hyphens.

Example: ‘my-cluster-snapshot2`

Returns:

  • (String) 


805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/aws-sdk-rds/types.rb', line 805

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