cachedi_scsi_volumes

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

Overview

Name	cachedi_scsi_volumes
Type	Resource
Id	aws.storagegateway.cachedi_scsi_volumes

Fields

The following fields are returned by SELECT queries:

describe_cachedi_scsi_volumes

Name	Datatype	Description
cachedi_scsi_volumes	array	An array of objects where each object contains metadata about one cached volume.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cachedi_scsi_volumes	select	region		Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
create_cachedi_scsi_volume	insert	region, GatewayARN, VolumeSizeInBytes, TargetName, NetworkInterfaceId, ClientToken		Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

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_cachedi_scsi_volumes

Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types. The list of gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

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

INSERT examples

create_cachedi_scsi_volume

Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type. Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway. In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target. Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

INSERT INTO aws.storagegateway.cachedi_scsi_volumes (
GatewayARN,
VolumeSizeInBytes,
SnapshotId,
TargetName,
SourceVolumeARN,
NetworkInterfaceId,
ClientToken,
KMSEncrypted,
KMSKey,
Tags,
region
)
SELECT 
'{{ GatewayARN }}' /* required */,
{{ VolumeSizeInBytes }} /* required */,
'{{ SnapshotId }}',
'{{ TargetName }}' /* required */,
'{{ SourceVolumeARN }}',
'{{ NetworkInterfaceId }}' /* required */,
'{{ ClientToken }}' /* required */,
{{ KMSEncrypted }},
'{{ KMSKey }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
target_arn,
volume_arn
;

Manifest

# Description fields are for documentation purposes
- name: cachedi_scsi_volumes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cachedi_scsi_volumes resource.
  - name: GatewayARN
    value: "{{ GatewayARN }}"
    description: |
      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
  - name: VolumeSizeInBytes
    value: {{ VolumeSizeInBytes }}
    description: |
      The size of the volume in bytes.
  - name: SnapshotId
    value: "{{ SnapshotId }}"
    description: |
      The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.
  - name: TargetName
    value: "{{ TargetName }}"
    description: |
      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.
  - name: SourceVolumeARN
    value: "{{ SourceVolumeARN }}"
    description: |
      The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
  - name: NetworkInterfaceId
    value: "{{ NetworkInterfaceId }}"
    description: |
      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.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.
  - name: KMSEncrypted
    value: {{ KMSEncrypted }}
    description: |
      Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional. Valid Values: true | false
  - name: KMSKey
    value: "{{ KMSKey }}"
    description: |
      The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
  - name: Tags
    description: |
      A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"