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	awscc.workspaces.workspaces_pools

Fields

get (all properties)

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
running_mode	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
pool_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	workspaces_pools	INSERT	PoolName, BundleId, DirectoryId, Capacity, region
delete_resource	workspaces_pools	DELETE	Identifier, region
update_resource	workspaces_pools	UPDATE	Identifier, PatchDocument, region
list_resources	workspaces_pools_list_only	SELECT	region
get_resource	workspaces_pools	SELECT	Identifier, region

SELECT examples

get (all properties)

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,
  running_mode,
  tags
FROM awscc.workspaces.workspaces_pools
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ pool_id }}';

list (identifiers only)

Lists all workspaces_pools in a region.

SELECT
  region,
  pool_id
FROM awscc.workspaces.workspaces_pools_list_only
WHERE
  region = '{{ region }}';

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 awscc.workspaces.workspaces_pools (
  Capacity,
  PoolName,
  BundleId,
  DirectoryId,
  region
)
SELECT
  '{{ capacity }}',
  '{{ pool_name }}',
  '{{ bundle_id }}',
  '{{ directory_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.workspaces.workspaces_pools (
  Capacity,
  PoolName,
  Description,
  BundleId,
  DirectoryId,
  ApplicationSettings,
  TimeoutSettings,
  RunningMode,
  Tags,
  region
)
SELECT
  '{{ capacity }}',
  '{{ pool_name }}',
  '{{ description }}',
  '{{ bundle_id }}',
  '{{ directory_id }}',
  '{{ application_settings }}',
  '{{ timeout_settings }}',
  '{{ running_mode }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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:
        desired_user_sessions: '{{ desired_user_sessions }}'
    - name: pool_name
      value: '{{ pool_name }}'
    - name: description
      value: '{{ description }}'
    - name: bundle_id
      value: '{{ bundle_id }}'
    - name: directory_id
      value: '{{ directory_id }}'
    - name: application_settings
      value:
        status: '{{ status }}'
        settings_group: '{{ settings_group }}'
    - name: timeout_settings
      value:
        disconnect_timeout_in_seconds: '{{ disconnect_timeout_in_seconds }}'
        idle_disconnect_timeout_in_seconds: '{{ idle_disconnect_timeout_in_seconds }}'
        max_user_duration_in_seconds: '{{ max_user_duration_in_seconds }}'
    - name: running_mode
      value: '{{ running_mode }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.workspaces.workspaces_pools
SET PatchDocument = string('{{ {
    "Capacity": capacity,
    "Description": description,
    "BundleId": bundle_id,
    "DirectoryId": directory_id,
    "ApplicationSettings": application_settings,
    "TimeoutSettings": timeout_settings,
    "RunningMode": running_mode,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ pool_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.workspaces.workspaces_pools
WHERE
  Identifier = '{{ pool_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

workspaces:CreateWorkspacesPool,
workspaces:DescribeWorkspacesPools,
workspaces:CreateTags

Read

workspaces:DescribeWorkspacesPools,
workspaces:DescribeTags

Update

workspaces:UpdateWorkspacesPool,
workspaces:CreateTags,
workspaces:DeleteTags,
workspaces:DescribeWorkspacesPools,
workspaces:DescribeTags

Delete

workspaces:DescribeWorkspacesPools,
workspaces:TerminateWorkspacesPool,
workspaces:DeleteTags

List

workspaces:DescribeWorkspacesPools,
workspaces:DescribeTags