user_settings

Creates, updates, deletes, gets or lists a user_settings resource.

Overview

Name	user_settings
Type	Resource
Id	aws.workspaces_web.user_settings

Fields

The following fields are returned by SELECT queries:

get_user_settings

Name	Datatype	Description
additional_encryption_context	object	The additional encryption context of the user settings.
associated_portal_arns	array	A list of web portal ARNs that this user settings is associated with.
branding_configuration	object	The branding configuration output that customizes the appearance of the web portal for end users.
cookie_synchronization_configuration	object	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
copy_allowed	string	Specifies whether the user can copy text from the streaming session to the local device. (Disabled, Enabled)
customer_managed_key	string	The customer managed key used to encrypt sensitive information in the user settings. (pattern: <code>arn:[\w+=/,.@-]+:kms:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:key/[a-zA-Z0-9-]+</code>)
deep_link_allowed	string	Specifies whether the user can use deep links that open automatically when connecting to a session. (Disabled, Enabled)
disconnect_timeout_in_minutes	integer	The amount of time that a streaming session remains active after users disconnect.
download_allowed	string	Specifies whether the user can download files from the streaming session to the local device. (Disabled, Enabled)
idle_disconnect_timeout_in_minutes	integer	The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
paste_allowed	string	Specifies whether the user can paste text from the local device to the streaming session. (Disabled, Enabled)
print_allowed	string	Specifies whether the user can print to the local device. (Disabled, Enabled)
toolbar_configuration	object	The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.
upload_allowed	string	Specifies whether the user can upload files from the local device to the streaming session. (Disabled, Enabled)
user_settings_arn	string	The ARN of the user settings. (pattern: <code>arn:[\w+=/,.@-]+:[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(/[a-fA-F0-9-]{36})+</code>)
web_authn_allowed	string	Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session. (Disabled, Enabled)

list_user_settings

Name	Datatype	Description
next_token	string	The pagination token used to retrieve the next page of results for this operation. (pattern: <code>\S+</code>)
user_settings	array	The user settings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_settings	select	user_settings_arn, region		Gets user settings.
list_user_settings	select	region	nextToken, maxResults	Retrieves a list of user settings.
create_user_settings	insert	region, copyAllowed, pasteAllowed, downloadAllowed, uploadAllowed, printAllowed		Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.
associate_user_settings	update	portal_arn, userSettingsArn, region		Associates a user settings resource with a web portal.
disassociate_user_settings	update	portal_arn, region		Disassociates user settings from a web portal.
update_user_settings	update	user_settings_arn, region		Updates the user settings.
delete_user_settings	delete	user_settings_arn, region		Deletes user settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
portal_arn	string	The ARN of the web portal.
region	string	AWS region (default: us-east-1)
userSettingsArn	string	The ARN of the user settings.
user_settings_arn	string	The ARN of the user settings.
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_user_settings

Gets user settings.

SELECT
additional_encryption_context,
associated_portal_arns,
branding_configuration,
cookie_synchronization_configuration,
copy_allowed,
customer_managed_key,
deep_link_allowed,
disconnect_timeout_in_minutes,
download_allowed,
idle_disconnect_timeout_in_minutes,
paste_allowed,
print_allowed,
toolbar_configuration,
upload_allowed,
user_settings_arn,
web_authn_allowed
FROM aws.workspaces_web.user_settings
WHERE user_settings_arn = '{{ user_settings_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_user_settings

Retrieves a list of user settings.

SELECT
next_token,
user_settings
FROM aws.workspaces_web.user_settings
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_user_settings

Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

INSERT INTO aws.workspaces_web.user_settings (
copyAllowed,
pasteAllowed,
downloadAllowed,
uploadAllowed,
printAllowed,
tags,
disconnectTimeoutInMinutes,
idleDisconnectTimeoutInMinutes,
clientToken,
cookieSynchronizationConfiguration,
customerManagedKey,
additionalEncryptionContext,
deepLinkAllowed,
toolbarConfiguration,
brandingConfigurationInput,
webAuthnAllowed,
region
)
SELECT 
'{{ copyAllowed }}' /* required */,
'{{ pasteAllowed }}' /* required */,
'{{ downloadAllowed }}' /* required */,
'{{ uploadAllowed }}' /* required */,
'{{ printAllowed }}' /* required */,
'{{ tags }}',
{{ disconnectTimeoutInMinutes }},
{{ idleDisconnectTimeoutInMinutes }},
'{{ clientToken }}',
'{{ cookieSynchronizationConfiguration }}',
'{{ customerManagedKey }}',
'{{ additionalEncryptionContext }}',
'{{ deepLinkAllowed }}',
'{{ toolbarConfiguration }}',
'{{ brandingConfigurationInput }}',
'{{ webAuthnAllowed }}',
'{{ region }}'
RETURNING
user_settings_arn
;

Manifest

# Description fields are for documentation purposes
- name: user_settings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the user_settings resource.
  - name: copyAllowed
    value: "{{ copyAllowed }}"
    valid_values: ['Disabled', 'Enabled']
  - name: pasteAllowed
    value: "{{ pasteAllowed }}"
    valid_values: ['Disabled', 'Enabled']
  - name: downloadAllowed
    value: "{{ downloadAllowed }}"
    valid_values: ['Disabled', 'Enabled']
  - name: uploadAllowed
    value: "{{ uploadAllowed }}"
    valid_values: ['Disabled', 'Enabled']
  - name: printAllowed
    value: "{{ printAllowed }}"
    valid_values: ['Disabled', 'Enabled']
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: disconnectTimeoutInMinutes
    value: {{ disconnectTimeoutInMinutes }}
  - name: idleDisconnectTimeoutInMinutes
    value: {{ idleDisconnectTimeoutInMinutes }}
  - name: clientToken
    value: "{{ clientToken }}"
  - name: cookieSynchronizationConfiguration
    description: |
      The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
    value:
      allowlist:
        - domain: "{{ domain }}"
          name: "{{ name }}"
          path: "{{ path }}"
      blocklist:
        - domain: "{{ domain }}"
          name: "{{ name }}"
          path: "{{ path }}"
  - name: customerManagedKey
    value: "{{ customerManagedKey }}"
  - name: additionalEncryptionContext
    value: "{{ additionalEncryptionContext }}"
  - name: deepLinkAllowed
    value: "{{ deepLinkAllowed }}"
    valid_values: ['Disabled', 'Enabled']
  - name: toolbarConfiguration
    description: |
      The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.
    value:
      toolbarType: "{{ toolbarType }}"
      visualMode: "{{ visualMode }}"
      hiddenToolbarItems:
        - "{{ hiddenToolbarItems }}"
      maxDisplayResolution: "{{ maxDisplayResolution }}"
  - name: brandingConfigurationInput
    description: |
      The input configuration for creating branding settings.
    value:
      logo:
        blob: "{{ blob }}"
        s3Uri: "{{ s3Uri }}"
      wallpaper:
        blob: "{{ blob }}"
        s3Uri: "{{ s3Uri }}"
      favicon:
        blob: "{{ blob }}"
        s3Uri: "{{ s3Uri }}"
      localizedStrings: "{{ localizedStrings }}"
      colorTheme: "{{ colorTheme }}"
      termsOfService: "{{ termsOfService }}"
  - name: webAuthnAllowed
    value: "{{ webAuthnAllowed }}"
    valid_values: ['Disabled', 'Enabled']

UPDATE examples

associate_user_settings

Associates a user settings resource with a web portal.

UPDATE aws.workspaces_web.user_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND userSettingsArn = '{{ userSettingsArn }}' --required
AND region = '{{ region }}' --required
RETURNING
portal_arn,
user_settings_arn;

disassociate_user_settings

Disassociates user settings from a web portal.

UPDATE aws.workspaces_web.user_settings
SET 
-- No updatable properties
WHERE 
portal_arn = '{{ portal_arn }}' --required
AND region = '{{ region }}' --required;

update_user_settings

Updates the user settings.

UPDATE aws.workspaces_web.user_settings
SET 
copyAllowed = '{{ copyAllowed }}',
pasteAllowed = '{{ pasteAllowed }}',
downloadAllowed = '{{ downloadAllowed }}',
uploadAllowed = '{{ uploadAllowed }}',
printAllowed = '{{ printAllowed }}',
disconnectTimeoutInMinutes = {{ disconnectTimeoutInMinutes }},
idleDisconnectTimeoutInMinutes = {{ idleDisconnectTimeoutInMinutes }},
clientToken = '{{ clientToken }}',
cookieSynchronizationConfiguration = '{{ cookieSynchronizationConfiguration }}',
deepLinkAllowed = '{{ deepLinkAllowed }}',
toolbarConfiguration = '{{ toolbarConfiguration }}',
brandingConfigurationInput = '{{ brandingConfigurationInput }}',
webAuthnAllowed = '{{ webAuthnAllowed }}'
WHERE 
user_settings_arn = '{{ user_settings_arn }}' --required
AND region = '{{ region }}' --required
RETURNING
user_settings;

DELETE examples

delete_user_settings

Deletes user settings.

DELETE FROM aws.workspaces_web.user_settings
WHERE user_settings_arn = '{{ user_settings_arn }}' --required
AND region = '{{ region }}' --required
;