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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticache/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",
  kms_key_id: "String",
}

Represents the input of a CopySnapshotMessage operation.

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_idString

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

Returns:

  • (String)


1098
1099
1100
1101
1102
1103
1104
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 1098

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

#source_snapshot_nameString

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

Returns:

  • (String)


1098
1099
1100
1101
1102
1103
1104
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 1098

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

#target_bucketString

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.

Returns:

  • (String)


1098
1099
1100
1101
1102
1103
1104
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 1098

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

#target_snapshot_nameString

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)


1098
1099
1100
1101
1102
1103
1104
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 1098

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