volumes

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

Overview

Name	volumes
Type	Resource
Id	aws.workspaces_instances.volumes

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_volume	insert	region, AvailabilityZone		Creates a new volume for WorkSpace Instances.
associate_volume	update	region, WorkspaceInstanceId, VolumeId, Device		Attaches a volume to a WorkSpace Instance.
disassociate_volume	update	region, WorkspaceInstanceId, VolumeId		Detaches a volume from a WorkSpace Instance.
delete_volume	delete	region		Deletes a specified volume.

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)

INSERT examples

create_volume

Creates a new volume for WorkSpace Instances.

INSERT INTO aws.workspaces_instances.volumes (
AvailabilityZone,
ClientToken,
Encrypted,
Iops,
KmsKeyId,
SizeInGB,
SnapshotId,
TagSpecifications,
Throughput,
VolumeType,
region
)
SELECT 
'{{ AvailabilityZone }}' /* required */,
'{{ ClientToken }}',
{{ Encrypted }},
{{ Iops }},
'{{ KmsKeyId }}',
{{ SizeInGB }},
'{{ SnapshotId }}',
'{{ TagSpecifications }}',
{{ Throughput }},
'{{ VolumeType }}',
'{{ region }}'
RETURNING
volume_id
;

Manifest

# Description fields are for documentation purposes
- name: volumes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the volumes resource.
  - name: AvailabilityZone
    value: "{{ AvailabilityZone }}"
    description: |
      Availability zone for the volume.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Unique token to prevent duplicate volume creation.
  - name: Encrypted
    value: {{ Encrypted }}
    description: |
      Indicates if the volume should be encrypted.
  - name: Iops
    value: {{ Iops }}
    description: |
      Input/output operations per second for the volume.
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"
    description: |
      KMS key for volume encryption.
  - name: SizeInGB
    value: {{ SizeInGB }}
    description: |
      Volume size in gigabytes.
  - name: SnapshotId
    value: "{{ SnapshotId }}"
    description: |
      Source snapshot for volume creation.
  - name: TagSpecifications
    description: |
      Metadata tags for the volume.
    value:
      - ResourceType: "{{ ResourceType }}"
        Tags: "{{ Tags }}"
  - name: Throughput
    value: {{ Throughput }}
    description: |
      Volume throughput performance.
  - name: VolumeType
    value: "{{ VolumeType }}"
    description: |
      Type of EBS volume.
    valid_values: ['standard', 'io1', 'io2', 'gp2', 'sc1', 'st1', 'gp3']

UPDATE examples

associate_volume

Attaches a volume to a WorkSpace Instance.

UPDATE aws.workspaces_instances.volumes
SET 
WorkspaceInstanceId = '{{ WorkspaceInstanceId }}',
VolumeId = '{{ VolumeId }}',
Device = '{{ Device }}'
WHERE 
region = '{{ region }}' --required
AND WorkspaceInstanceId = '{{ WorkspaceInstanceId }}' --required
AND VolumeId = '{{ VolumeId }}' --required
AND Device = '{{ Device }}' --required;

disassociate_volume

Detaches a volume from a WorkSpace Instance.

UPDATE aws.workspaces_instances.volumes
SET 
WorkspaceInstanceId = '{{ WorkspaceInstanceId }}',
VolumeId = '{{ VolumeId }}',
Device = '{{ Device }}',
DisassociateMode = '{{ DisassociateMode }}'
WHERE 
region = '{{ region }}' --required
AND WorkspaceInstanceId = '{{ WorkspaceInstanceId }}' --required
AND VolumeId = '{{ VolumeId }}' --required;

DELETE examples

delete_volume

Deletes a specified volume.

DELETE FROM aws.workspaces_instances.volumes
WHERE region = '{{ region }}' --required
;