user_settings

Creates, updates, deletes or gets an user_setting resource or lists user_settings in a region

Overview

Name	user_settings
Type	Resource
Description	Definition of AWS::WorkSpacesWeb::UserSettings Resource Type
Id	awscc.workspacesweb.user_settings

Fields

get (all properties)

Name	Datatype	Description
additional_encryption_context	object
associated_portal_arns	array
▶cookie_synchronization_configuration	object
copy_allowed	string
customer_managed_key	string
disconnect_timeout_in_minutes	number
idle_disconnect_timeout_in_minutes	number
▶tags	array
▶toolbar_configuration	object
user_settings_arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
user_settings_arn	string
region	string	AWS region.

For more information, see AWS::WorkSpacesWeb::UserSettings.

Methods

Name	Resource	Accessible by	Required Params
create_resource	user_settings	INSERT	CopyAllowed, DownloadAllowed, PasteAllowed, PrintAllowed, UploadAllowed, region
delete_resource	user_settings	DELETE	Identifier, region
update_resource	user_settings	UPDATE	Identifier, PatchDocument, region
list_resources	user_settings_list_only	SELECT	region
get_resource	user_settings	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual user_setting.

SELECT
  region,
  additional_encryption_context,
  associated_portal_arns,
  cookie_synchronization_configuration,
  copy_allowed,
  customer_managed_key,
  disconnect_timeout_in_minutes,
  download_allowed,
  idle_disconnect_timeout_in_minutes,
  paste_allowed,
  print_allowed,
  tags,
  toolbar_configuration,
  upload_allowed,
  user_settings_arn,
  deep_link_allowed
FROM awscc.workspacesweb.user_settings
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_settings_arn }}';

list (identifiers only)

Lists all user_settings in a region.

SELECT
  region,
  user_settings_arn
FROM awscc.workspacesweb.user_settings_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.workspacesweb.user_settings (
  CopyAllowed,
  DownloadAllowed,
  PasteAllowed,
  PrintAllowed,
  UploadAllowed,
  region
)
SELECT
  '{{ copy_allowed }}',
  '{{ download_allowed }}',
  '{{ paste_allowed }}',
  '{{ print_allowed }}',
  '{{ upload_allowed }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.workspacesweb.user_settings (
  AdditionalEncryptionContext,
  CookieSynchronizationConfiguration,
  CopyAllowed,
  CustomerManagedKey,
  DisconnectTimeoutInMinutes,
  DownloadAllowed,
  IdleDisconnectTimeoutInMinutes,
  PasteAllowed,
  PrintAllowed,
  Tags,
  ToolbarConfiguration,
  UploadAllowed,
  DeepLinkAllowed,
  region
)
SELECT
  '{{ additional_encryption_context }}',
  '{{ cookie_synchronization_configuration }}',
  '{{ copy_allowed }}',
  '{{ customer_managed_key }}',
  '{{ disconnect_timeout_in_minutes }}',
  '{{ download_allowed }}',
  '{{ idle_disconnect_timeout_in_minutes }}',
  '{{ paste_allowed }}',
  '{{ print_allowed }}',
  '{{ tags }}',
  '{{ toolbar_configuration }}',
  '{{ upload_allowed }}',
  '{{ deep_link_allowed }}',
  '{{ 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: user_setting
  props:
    - name: additional_encryption_context
      value: {}
    - name: cookie_synchronization_configuration
      value:
        allowlist:
          - domain: '{{ domain }}'
            name: '{{ name }}'
            path: '{{ path }}'
        blocklist:
          - null
    - name: copy_allowed
      value: '{{ copy_allowed }}'
    - name: customer_managed_key
      value: '{{ customer_managed_key }}'
    - name: disconnect_timeout_in_minutes
      value: null
    - name: download_allowed
      value: null
    - name: idle_disconnect_timeout_in_minutes
      value: null
    - name: paste_allowed
      value: null
    - name: print_allowed
      value: null
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: toolbar_configuration
      value:
        toolbar_type: '{{ toolbar_type }}'
        visual_mode: '{{ visual_mode }}'
        hidden_toolbar_items:
          - '{{ hidden_toolbar_items[0] }}'
        max_display_resolution: '{{ max_display_resolution }}'
    - name: upload_allowed
      value: null
    - name: deep_link_allowed
      value: null

UPDATE example

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

/*+ update */
UPDATE awscc.workspacesweb.user_settings
SET PatchDocument = string('{{ {
    "AdditionalEncryptionContext": additional_encryption_context,
    "CookieSynchronizationConfiguration": cookie_synchronization_configuration,
    "CopyAllowed": copy_allowed,
    "CustomerManagedKey": customer_managed_key,
    "DisconnectTimeoutInMinutes": disconnect_timeout_in_minutes,
    "DownloadAllowed": download_allowed,
    "IdleDisconnectTimeoutInMinutes": idle_disconnect_timeout_in_minutes,
    "PasteAllowed": paste_allowed,
    "PrintAllowed": print_allowed,
    "Tags": tags,
    "ToolbarConfiguration": toolbar_configuration,
    "UploadAllowed": upload_allowed,
    "DeepLinkAllowed": deep_link_allowed
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_settings_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.workspacesweb.user_settings
WHERE
  Identifier = '{{ user_settings_arn }}' 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 user_settings resource, the following permissions are required:

Create

workspaces-web:CreateUserSettings,
workspaces-web:GetUserSettings,
workspaces-web:ListTagsForResource,
workspaces-web:TagResource,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt,
kms:GenerateDataKeyWithoutPlaintext,
kms:ReEncryptTo,
kms:ReEncryptFrom

Read

workspaces-web:GetUserSettings,
workspaces-web:ListTagsForResource,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Update

workspaces-web:UpdateUserSettings,
workspaces-web:TagResource,
workspaces-web:UntagResource,
workspaces-web:GetUserSettings,
workspaces-web:ListTagsForResource,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

Delete

workspaces-web:GetUserSettings,
workspaces-web:DeleteUserSettings,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

List

workspaces-web:ListUserSettings,
kms:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt