Skip to main content

storedi_scsi_volumes

Creates, updates, deletes, gets or lists a storedi_scsi_volumes resource.

Overview​

Namestoredi_scsi_volumes
TypeResource
Idaws.storagegateway.storedi_scsi_volumes

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
storedi_scsi_volumesarrayDescribes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned: ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target. LunNumber: The logical disk number. NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target. NetworkInterfacePort: The port used to communicate with iSCSI targets. PreservedExistingData: Indicates when the stored volume was created, existing data on the underlying local disk was preserved. SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included. StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume. TargetARN: The Amazon Resource Name (ARN) of the volume target. VolumeARN: The Amazon Resource Name (ARN) of the stored volume. VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation. VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB. VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume. VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping. VolumeSizeInBytes: The size of the volume in bytes. VolumeStatus: One of the VolumeStatus values that indicates the state of the volume. VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_storedi_scsi_volumesselectregionReturns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.
create_storedi_scsi_volumeinsertregion, GatewayARN, DiskId, PreserveExistingData, TargetName, NetworkInterfaceIdCreates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

SELECT
storedi_scsi_volumes
FROM aws.storagegateway.storedi_scsi_volumes
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type. The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased. In the request, you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

INSERT INTO aws.storagegateway.storedi_scsi_volumes (
GatewayARN,
DiskId,
SnapshotId,
PreserveExistingData,
TargetName,
NetworkInterfaceId,
KMSEncrypted,
KMSKey,
Tags,
region
)
SELECT 
'{{ GatewayARN }}' /* required */,
'{{ DiskId }}' /* required */,
'{{ SnapshotId }}',
{{ PreserveExistingData }} /* required */,
'{{ TargetName }}' /* required */,
'{{ NetworkInterfaceId }}' /* required */,
{{ KMSEncrypted }},
'{{ KMSKey }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
target_arn,
volume_arn,
volume_size_in_bytes
;
Last updated on