Amazon Storage Gateway · Schema
AttachVolumeInput
AttachVolumeInput
BackupFile StorageGatewayHybrid CloudStorage
Properties
| Name | Type | Description |
|---|---|---|
| GatewayARN | object | |
| TargetName | object | |
| VolumeARN | object | |
| NetworkInterfaceId | object | |
| DiskId | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-schema/amazon-storage-gateway-attach-volume-input-schema.json",
"title": "AttachVolumeInput",
"description": "AttachVolumeInput",
"type": "object",
"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"
]
}