workspaces_pools

Creates, updates, deletes or gets a workspaces_pool resource or lists workspaces_pools in a region

Overview

Name	workspaces_pools
Type	Resource
Description	Resource Type definition for AWS::WorkSpaces::WorkspacesPool
Id	aws.workspaces.workspaces_pools

Fields

Name	Datatype	Description
pool_id	string
pool_arn	string
capacity	object
pool_name	string
description	string
created_at	string
bundle_id	string
directory_id	string
application_settings	object
timeout_settings	object
tags	array
region	string	AWS region.

For more information, see AWS::WorkSpaces::WorkspacesPool.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	PoolName, BundleId, DirectoryId, Capacity, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all workspaces_pools in a region.

SELECT
region,
pool_id,
pool_arn,
capacity,
pool_name,
description,
created_at,
bundle_id,
directory_id,
application_settings,
timeout_settings,
tags
FROM aws.workspaces.workspaces_pools
WHERE region = 'us-east-1';

Gets all properties from an individual workspaces_pool.

SELECT
region,
pool_id,
pool_arn,
capacity,
pool_name,
description,
created_at,
bundle_id,
directory_id,
application_settings,
timeout_settings,
tags
FROM aws.workspaces.workspaces_pools
WHERE region = 'us-east-1' AND data__Identifier = '<PoolId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.workspaces.workspaces_pools (
 Capacity,
 PoolName,
 BundleId,
 DirectoryId,
 region
)
SELECT 
'{{ Capacity }}',
 '{{ PoolName }}',
 '{{ BundleId }}',
 '{{ DirectoryId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspaces.workspaces_pools (
 Capacity,
 PoolName,
 Description,
 BundleId,
 DirectoryId,
 ApplicationSettings,
 TimeoutSettings,
 Tags,
 region
)
SELECT 
 '{{ Capacity }}',
 '{{ PoolName }}',
 '{{ Description }}',
 '{{ BundleId }}',
 '{{ DirectoryId }}',
 '{{ ApplicationSettings }}',
 '{{ TimeoutSettings }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: workspaces_pool
    props:
      - name: Capacity
        value:
          DesiredUserSessions: '{{ DesiredUserSessions }}'
      - name: PoolName
        value: '{{ PoolName }}'
      - name: Description
        value: '{{ Description }}'
      - name: BundleId
        value: '{{ BundleId }}'
      - name: DirectoryId
        value: '{{ DirectoryId }}'
      - name: ApplicationSettings
        value:
          Status: '{{ Status }}'
          SettingsGroup: '{{ SettingsGroup }}'
      - name: TimeoutSettings
        value:
          DisconnectTimeoutInSeconds: '{{ DisconnectTimeoutInSeconds }}'
          IdleDisconnectTimeoutInSeconds: '{{ IdleDisconnectTimeoutInSeconds }}'
          MaxUserDurationInSeconds: '{{ MaxUserDurationInSeconds }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.workspaces.workspaces_pools
WHERE data__Identifier = '<PoolId>'
AND region = 'us-east-1';

Permissions

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

Create

workspaces:CreateWorkspacesPool,
workspaces:DescribeWorkspacesPools

Read

workspaces:DescribeWorkspacesPools

Update

workspaces:UpdateWorkspacesPool

Delete

workspaces:DescribeWorkspacesPools,
workspaces:TerminateWorkspacesPool

List

workspaces:DescribeWorkspacesPools