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

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

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 AttachVolumeInput data as a hash:

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

AttachVolumeInput

Instance Attribute Summary collapse

Instance Attribute Details

#disk_idString

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)


444
445
446
447
448
449
450
451
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 444

class AttachVolumeInput < Struct.new(
  :gateway_arn,
  :target_name,
  :volume_arn,
  :network_interface_id,
  :disk_id)
  include Aws::Structure
end

#gateway_arnString

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

Returns:

  • (String)


444
445
446
447
448
449
450
451
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 444

class AttachVolumeInput < Struct.new(
  :gateway_arn,
  :target_name,
  :volume_arn,
  :network_interface_id,
  :disk_id)
  include Aws::Structure
end

#network_interface_idString

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)


444
445
446
447
448
449
450
451
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 444

class AttachVolumeInput < Struct.new(
  :gateway_arn,
  :target_name,
  :volume_arn,
  :network_interface_id,
  :disk_id)
  include Aws::Structure
end

#target_nameString

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)


444
445
446
447
448
449
450
451
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 444

class AttachVolumeInput < Struct.new(
  :gateway_arn,
  :target_name,
  :volume_arn,
  :network_interface_id,
  :disk_id)
  include Aws::Structure
end

#volume_arnString

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

Returns:

  • (String)


444
445
446
447
448
449
450
451
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 444

class AttachVolumeInput < Struct.new(
  :gateway_arn,
  :target_name,
  :volume_arn,
  :network_interface_id,
  :disk_id)
  include Aws::Structure
end