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

Class: Aws::StorageGateway::Types::CreateSnapshotInput

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

Overview

Note:

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

{
  volume_arn: "VolumeARN", # required
  snapshot_description: "SnapshotDescription", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

A JSON object containing one or more of the following fields:

  • CreateSnapshotInput$SnapshotDescription

  • CreateSnapshotInput$VolumeARN

Instance Attribute Summary collapse

Instance Attribute Details

#snapshot_descriptionString

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

Returns:

  • (String)


1309
1310
1311
1312
1313
1314
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1309

class CreateSnapshotInput < Struct.new(
  :volume_arn,
  :snapshot_description,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Returns:



1309
1310
1311
1312
1313
1314
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1309

class CreateSnapshotInput < Struct.new(
  :volume_arn,
  :snapshot_description,
  :tags)
  include Aws::Structure
end

#volume_arnString

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Returns:

  • (String)


1309
1310
1311
1312
1313
1314
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1309

class CreateSnapshotInput < Struct.new(
  :volume_arn,
  :snapshot_description,
  :tags)
  include Aws::Structure
end