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	aws.workspacesweb.user_settings

Fields

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
download_allowed	string
idle_disconnect_timeout_in_minutes	number
paste_allowed	string
print_allowed	string
tags	array
upload_allowed	string
user_settings_arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	CopyAllowed, DownloadAllowed, PasteAllowed, PrintAllowed, UploadAllowed, 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 user_settings in a region.

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,
upload_allowed,
user_settings_arn
FROM aws.workspacesweb.user_settings
WHERE region = 'us-east-1';

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,
upload_allowed,
user_settings_arn
FROM aws.workspacesweb.user_settings
WHERE region = 'us-east-1' AND data__Identifier = '<UserSettingsArn>';

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 aws.workspacesweb.user_settings (
 CopyAllowed,
 DownloadAllowed,
 PasteAllowed,
 PrintAllowed,
 UploadAllowed,
 region
)
SELECT 
'{{ CopyAllowed }}',
 '{{ DownloadAllowed }}',
 '{{ PasteAllowed }}',
 '{{ PrintAllowed }}',
 '{{ UploadAllowed }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.workspacesweb.user_settings (
 AdditionalEncryptionContext,
 CookieSynchronizationConfiguration,
 CopyAllowed,
 CustomerManagedKey,
 DisconnectTimeoutInMinutes,
 DownloadAllowed,
 IdleDisconnectTimeoutInMinutes,
 PasteAllowed,
 PrintAllowed,
 Tags,
 UploadAllowed,
 region
)
SELECT 
 '{{ AdditionalEncryptionContext }}',
 '{{ CookieSynchronizationConfiguration }}',
 '{{ CopyAllowed }}',
 '{{ CustomerManagedKey }}',
 '{{ DisconnectTimeoutInMinutes }}',
 '{{ DownloadAllowed }}',
 '{{ IdleDisconnectTimeoutInMinutes }}',
 '{{ PasteAllowed }}',
 '{{ PrintAllowed }}',
 '{{ Tags }}',
 '{{ UploadAllowed }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_setting
    props:
      - name: AdditionalEncryptionContext
        value: {}
      - name: CookieSynchronizationConfiguration
        value:
          Allowlist:
            - Domain: '{{ Domain }}'
              Name: '{{ Name }}'
              Path: '{{ Path }}'
          Blocklist:
            - null
      - name: CopyAllowed
        value: '{{ CopyAllowed }}'
      - name: CustomerManagedKey
        value: '{{ CustomerManagedKey }}'
      - name: DisconnectTimeoutInMinutes
        value: null
      - name: DownloadAllowed
        value: null
      - name: IdleDisconnectTimeoutInMinutes
        value: null
      - name: PasteAllowed
        value: null
      - name: PrintAllowed
        value: null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: UploadAllowed
        value: null

DELETE example

/*+ delete */
DELETE FROM aws.workspacesweb.user_settings
WHERE data__Identifier = '<UserSettingsArn>'
AND region = 'us-east-1';

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:CreateGrant,
kms:DescribeKey,
kms:GenerateDataKey,
kms:Decrypt

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