vtl_devices
Creates, updates, deletes, gets or lists a vtl_devices resource.
Overview
| Name | vtl_devices |
| Type | Resource |
| Id | aws.storagegateway.vtl_devices |
Fields
The following fields are returned by SELECT queries:
- describe_vtl_devices
| Name | Datatype | Description |
|---|---|---|
devicei_scsi_attributes | object | A list of iSCSI information about a VTL device. |
vtl_device_arn | string | Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer). |
vtl_device_product_identifier | string | Specifies the model number of device that the VTL device emulates. |
vtl_device_type | string | Specifies the type of device that the VTL device emulates. |
vtl_device_vendor | string | Specifies the vendor of the device that the VTL device object emulates. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_vtl_devices | select | region | Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type. | |
update_vtl_device_type | update | region, VTLDeviceARN, DeviceType | Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_vtl_devices
Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, Storage Gateway returns VTL device information. This operation is only supported in the tape gateway type.
SELECT
devicei_scsi_attributes,
vtl_device_arn,
vtl_device_product_identifier,
vtl_device_type,
vtl_device_vendor
FROM aws.storagegateway.vtl_devices
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_vtl_device_type
Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.
UPDATE aws.storagegateway.vtl_devices
SET
VTLDeviceARN = '{{ VTLDeviceARN }}',
DeviceType = '{{ DeviceType }}'
WHERE
region = '{{ region }}' --required
AND VTLDeviceARN = '{{ VTLDeviceARN }}' --required
AND DeviceType = '{{ DeviceType }}' --required
RETURNING
vtl_device_arn;