Skip to content

Attach Volume

storagegateway_attach_volume R Documentation

Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway

Description

Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

Usage

storagegateway_attach_volume(GatewayARN, TargetName, VolumeARN,
  NetworkInterfaceId, DiskId)

Arguments

GatewayARN

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

TargetName

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.

VolumeARN

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

NetworkInterfaceId

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

Valid Values: A valid IP address.

DiskId

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.

Value

A list with the following syntax: 

list(
  VolumeARN = "string",
  TargetARN = "string"
)

Request syntax

svc$attach_volume(
  GatewayARN = "string",
  TargetName = "string",
  VolumeARN = "string",
  NetworkInterfaceId = "string",
  DiskId = "string"
)