Class: Aws::ElastiCache::Types::CopySnapshotMessage

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

Overview

Represents the input of a ‘CopySnapshotMessage` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_id ⇒ String

The ID of the KMS key used to encrypt the target snapshot.

Returns:

  • (String) 


1587
1588
1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/aws-sdk-elasticache/types.rb', line 1587

class CopySnapshotMessage < Struct.new(
  :source_snapshot_name,
  :target_snapshot_name,
  :target_bucket,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_snapshot_name ⇒ String

The name of an existing snapshot from which to make a copy.

Returns:

  • (String) 


1587
1588
1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/aws-sdk-elasticache/types.rb', line 1587

class CopySnapshotMessage < Struct.new(
  :source_snapshot_name,
  :target_snapshot_name,
  :target_bucket,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Returns:



1587
1588
1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/aws-sdk-elasticache/types.rb', line 1587

class CopySnapshotMessage < Struct.new(
  :source_snapshot_name,
  :target_snapshot_name,
  :target_bucket,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_bucket ⇒ String

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see [Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket] in the *Amazon ElastiCache User Guide*.

For more information, see [Exporting a Snapshot] in the *Amazon ElastiCache User Guide*.

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access [2]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html

Returns:

  • (String) 


1587
1588
1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/aws-sdk-elasticache/types.rb', line 1587

class CopySnapshotMessage < Struct.new(
  :source_snapshot_name,
  :target_snapshot_name,
  :target_bucket,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_snapshot_name ⇒ String

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

Returns:

  • (String) 


1587
1588
1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/aws-sdk-elasticache/types.rb', line 1587

class CopySnapshotMessage < Struct.new(
  :source_snapshot_name,
  :target_snapshot_name,
  :target_bucket,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end