Skip to content

AttachVolumeInput

Source code in docs_src/capo_storage_gateway/types/attach_volume_input.py
class AttachVolumeInput(TypedDict, closed=True):
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN"
    """<p>The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.</p>"""
    target_name: NotRequired["capo_storage_gateway.types.target_name.TargetName"]
    """<p>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 <code>TargetName</code> as <i>myvolume</i> results in the target ARN of <code>arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume</code>. The target name must be unique across all volumes on a gateway.</p> <p>If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.</p>"""
    volume_arn: "capo_storage_gateway.types.volume_arn.VolumeARN"
    """<p>The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.</p>"""
    network_interface_id: (
        "capo_storage_gateway.types.network_interface_id.NetworkInterfaceId"
    )
    """<p>The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway.</p> <p>Valid Values: A valid IP address.</p>"""
    disk_id: NotRequired["capo_storage_gateway.types.disk_id.DiskId"]
    """<p>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.</p>"""

disk_id instance-attribute

disk_id: NotRequired[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.

gateway_arn instance-attribute

gateway_arn: GatewayARN

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

network_interface_id instance-attribute

network_interface_id: NetworkInterfaceId

The network interface of the gateway on which to expose the iSCSI target. Accepts IPv4 and IPv6 addresses. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

target_name instance-attribute

target_name: NotRequired[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.

volume_arn instance-attribute

volume_arn: VolumeARN

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