Class: Aws::StorageGateway::Types::CreateCachediSCSIVolumeInput

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::CreateCachediSCSIVolumeInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-storagegateway/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique identifier that you use to retry a request.

• #gateway_arn ⇒ String

  The Amazon Resource Name (ARN) of the gateway.

• #kms_encrypted ⇒ Boolean

  Set to ‘true` to use Amazon S3 server-side encryption with your own KMS key, or `false` to use a key managed by Amazon S3.

• #kms_key ⇒ String

  The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.

• #network_interface_id ⇒ String

  The network interface of the gateway on which to expose the iSCSI target.

• #snapshot_id ⇒ String

  The snapshot ID (e.g. “snap-1122aabb”) of the snapshot to restore as the new cached volume.

• #source_volume_arn ⇒ String

  The ARN for an existing volume.

• #tags ⇒ Array<Types::Tag>

  A list of up to 50 tags that you can assign to a cached volume.

• #target_name ⇒ String

  The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.

• #volume_size_in_bytes ⇒ Integer

  The size of the volume in bytes.

Instance Attribute Details

#client_token ⇒ String

A unique identifier that you use to retry a request. If you retry a request, use the same ‘ClientToken` you specified in the initial request.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_arn ⇒ String

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_encrypted ⇒ Boolean

Set to ‘true` to use Amazon S3 server-side encryption with your own KMS key, or `false` to use a key managed by Amazon S3. Optional.

Valid Values: ‘true` | `false`

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key ⇒ String

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when ‘KMSEncrypted` is `true`. Optional.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_id ⇒ String

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_id ⇒ String

The snapshot ID (e.g. “snap-1122aabb”) of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use

DescribeSnapshots][1

in the *Amazon Elastic Compute Cloud API

Reference*.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_volume_arn ⇒ String

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume’s latest recovery point. The ‘VolumeSizeInBytes` value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

<note markdown=“1”> Valid characters for key and value are letters, spaces, and numbers that you can represent 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 characters.

</note>

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#target_name ⇒ String

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying ‘TargetName` as myvolume results in the target ARN of `arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume`. The target name must be unique across all volumes on a gateway.

If you don’t specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#volume_size_in_bytes ⇒ Integer

The size of the volume in bytes.

Returns:

• (Integer)

# File 'lib/aws-sdk-storagegateway/types.rb', line 997

class CreateCachediSCSIVolumeInput < Struct.new(
  :gateway_arn,
  :volume_size_in_bytes,
  :snapshot_id,
  :target_name,
  :source_volume_arn,
  :network_interface_id,
  :client_token,
  :kms_encrypted,
  :kms_key,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end