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

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

Overview

Note:

When making an API call, you may pass CopySnapshotMessage data as a hash:

{
  source_snapshot_name: "String", # required
  target_snapshot_name: "String", # required
  target_bucket: "String",
}

Represents the input of a ‘CopySnapshotMessage` operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#source_snapshot_name ⇒ String

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

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
 
# File 'lib/aws-sdk-elasticache/types.rb', line 1047

class CopySnapshotMessage < Struct.new(
  :source_snapshot_name,
  :target_snapshot_name,
  :target_bucket)
  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/Snapshots.Exporting.html#Snapshots.Exporting.GrantAccess [2]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html

Returns:

  • (String) 


1047
1048
1049
1050
1051
1052
 
# File 'lib/aws-sdk-elasticache/types.rb', line 1047

class CopySnapshotMessage < Struct.new(
  :source_snapshot_name,
  :target_snapshot_name,
  :target_bucket)
  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) 


1047
1048
1049
1050
1051
1052
 
# File 'lib/aws-sdk-elasticache/types.rb', line 1047

class CopySnapshotMessage < Struct.new(
  :source_snapshot_name,
  :target_snapshot_name,
  :target_bucket)
  include Aws::Structure
end