Amazon Storage Gateway · JSON Structure

Amazon Storage Gateway Attach Volume Input Structure

AttachVolumeInput

Type: object Properties: 5 Required: 3
BackupFile StorageGatewayHybrid CloudStorage

AttachVolumeInput is a JSON Structure definition published by Amazon Storage Gateway, describing 5 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

GatewayARN TargetName VolumeARN NetworkInterfaceId DiskId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-structure/amazon-storage-gateway-attach-volume-input-structure.json",
  "name": "AttachVolumeInput",
  "description": "AttachVolumeInput",
  "properties": {
    "GatewayARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GatewayARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to."
        }
      ]
    },
    "TargetName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetName"
        },
        {
          "description": "<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>"
        }
      ]
    },
    "VolumeARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VolumeARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the volume to attach to the specified gateway."
        }
      ]
    },
    "NetworkInterfaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NetworkInterfaceId"
        },
        {
          "description": "<p>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. 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>"
        }
      ]
    },
    "DiskId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DiskId"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "required": [
    "GatewayARN",
    "VolumeARN",
    "NetworkInterfaceId"
  ]
}