AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Constant Summary collapse

SENSITIVE =
[]

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 Storage Gateway snapshot Details pane, Description field.

Returns:

  • (String)


1942
1943
1944
1945
1946
1947
1948
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1942

class CreateSnapshotInput < Struct.new(
  :volume_arn,
  :snapshot_description,
  :tags)
  SENSITIVE = []
  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:



1942
1943
1944
1945
1946
1947
1948
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1942

class CreateSnapshotInput < Struct.new(
  :volume_arn,
  :snapshot_description,
  :tags)
  SENSITIVE = []
  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)


1942
1943
1944
1945
1946
1947
1948
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1942

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