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

Class: Aws::StorageGateway::Types::CreateStorediSCSIVolumeInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateStorediSCSIVolumeInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  gateway_arn: "GatewayARN", # required
  disk_id: "DiskId", # required
  snapshot_id: "SnapshotId",
  preserve_existing_data: false, # required
  target_name: "TargetName", # required
  network_interface_id: "NetworkInterfaceId", # required
  kms_encrypted: false,
  kms_key: "KMSKey",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#disk_id ⇒ String

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Returns:

  • (String) —

    The unique identifier for the gateway local disk that is configured as a stored volume.

#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 AWS Region.

Returns:

  • (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 AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Returns:

  • (Boolean) —

    Set to true to use Amazon S3 server-side encryption with your own AWS 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. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Returns:

  • (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. 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) —

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

#preserve_existing_data ⇒ Boolean

Set to true true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

Returns:

  • (Boolean) —

    Set to true true if you want to preserve the data on the local disk.

#snapshot_id ⇒ String

The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored 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 in the Amazon Elastic Compute Cloud API Reference.

Returns:

  • (String) —

    The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume.

#tags ⇒ Array<Types::Tag>

A list of up to 50 tags that can be assigned to a stored volume. 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:

  • (Array<Types::Tag>) —

    A list of up to 50 tags that can be assigned to a stored 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. 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) —

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