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

Class: Aws::StorageGateway::Types::AttachVolumeInput

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

Overview

Note:

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

{
  gateway_arn: "GatewayARN", # required
  target_name: "TargetName",
  volume_arn: "VolumeARN", # required
  network_interface_id: "NetworkInterfaceId", # required
  disk_id: "DiskId",
}

AttachVolumeInput

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#disk_id ⇒ String

The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.

Returns:

  • (String) —

    The unique device ID or other distinguishing data that identifies the local disk used to create the volume.

#gateway_arn ⇒ String

The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.

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

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

#volume_arn ⇒ String

The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.