volume_associations

Creates, updates, deletes or gets a volume_association resource or lists volume_associations in a region

Overview

Name	volume_associations
Type	Resource
Description	Resource Type definition for AWS::WorkspacesInstances::VolumeAssociation
Id	awscc.workspacesinstances.volume_associations

Fields

Name	Datatype	Description
workspace_instance_id	string	ID of the workspace instance to associate with the volume
volume_id	string	ID of the volume to attach to the workspace instance
device	string	The device name for the volume attachment
disassociate_mode	string	Mode to use when disassociating the volume
region	string	AWS region.

For more information, see AWS::WorkspacesInstances::VolumeAssociation.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	WorkspaceInstanceId, VolumeId, Device, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual volume_association.

SELECT
region,
workspace_instance_id,
volume_id,
device,
disassociate_mode
FROM awscc.workspacesinstances.volume_associations
WHERE region = 'us-east-1' AND data__Identifier = '<WorkspaceInstanceId>|<VolumeId>|<Device>';

INSERT example

Use the following StackQL query and manifest file to create a new volume_association resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.workspacesinstances.volume_associations (
 WorkspaceInstanceId,
 VolumeId,
 Device,
 region
)
SELECT 
'{{ WorkspaceInstanceId }}',
 '{{ VolumeId }}',
 '{{ Device }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.workspacesinstances.volume_associations (
 WorkspaceInstanceId,
 VolumeId,
 Device,
 DisassociateMode,
 region
)
SELECT 
 '{{ WorkspaceInstanceId }}',
 '{{ VolumeId }}',
 '{{ Device }}',
 '{{ DisassociateMode }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: volume_association
    props:
      - name: WorkspaceInstanceId
        value: '{{ WorkspaceInstanceId }}'
      - name: VolumeId
        value: '{{ VolumeId }}'
      - name: Device
        value: '{{ Device }}'
      - name: DisassociateMode
        value: '{{ DisassociateMode }}'

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesinstances.volume_associations
WHERE data__Identifier = '<WorkspaceInstanceId|VolumeId|Device>'
AND region = 'us-east-1';

Permissions

To operate on the volume_associations resource, the following permissions are required:

Create

ec2:DescribeVolumes,
ec2:AttachVolume,
workspaces-instances:GetWorkspaceInstance,
workspaces-instances:AssociateVolume

Read

ec2:DescribeVolumes,
workspaces-instances:GetWorkspaceInstance

Delete

ec2:DescribeVolumes,
ec2:DetachVolume,
workspaces-instances:GetWorkspaceInstance,
workspaces-instances:DisassociateVolume

List

ec2:DescribeVolumes,
workspaces-instances:ListWorkspaceInstances