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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_tagsBoolean

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)


446
447
448
449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 446

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

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


446
447
448
449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 446

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

Not currently supported.

Returns:

  • (String)


446
447
448
449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 446

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 is not case-sensitive.

Constraints:

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

  • Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

Returns:

  • (String)


446
447
448
449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 446

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)


446
447
448
449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 446

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>

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

Returns:



446
447
448
449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 446

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


446
447
448
449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-neptune/lib/aws-sdk-neptune/types.rb', line 446

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