UserSettings

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.

userSettingsArn

The ARN of the user settings.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$

Required: Yes

additionalEncryptionContext

The additional encryption context of the user settings.

Type: String to string map

Key Length Constraints: Minimum length of 0. Maximum length of 131072.

Key Pattern: ^[\s\S]*$

Value Length Constraints: Minimum length of 0. Maximum length of 131072.

Value Pattern: ^[\s\S]*$

Required: No

associatedPortalArns

A list of web portal ARNs that this user settings is associated with.

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[\w+=\/,.@-]+:[a-zA-Z0-9\-]+:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\/[a-fA-F0-9\-]{36})+$

Required: No

cookieSynchronizationConfiguration

The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

Type: CookieSynchronizationConfiguration object

Required: No

copyAllowed

Specifies whether the user can copy text from the streaming session to the local device.

Type: String

Valid Values: Disabled | Enabled

Required: No

customerManagedKey

The customer managed key used to encrypt sensitive information in the user settings.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

Required: No

deepLinkAllowed

Specifies whether the user can use deep links that open automatically when connecting to a session.

Type: String

Valid Values: Disabled | Enabled

Required: No

disconnectTimeoutInMinutes

The amount of time that a streaming session remains active after users disconnect.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 600.

Required: No

downloadAllowed

Specifies whether the user can download files from the streaming session to the local device.

Type: String

Valid Values: Disabled | Enabled

Required: No

idleDisconnectTimeoutInMinutes

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 60.

Required: No

pasteAllowed

Specifies whether the user can paste text from the local device to the streaming session.

Type: String

Valid Values: Disabled | Enabled

Required: No

printAllowed

Specifies whether the user can print to the local device.

Type: String

Valid Values: Disabled | Enabled

Required: No

toolbarConfiguration

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.

Type: ToolbarConfiguration object

Required: No

uploadAllowed

Specifies whether the user can upload files from the local device to the streaming session.

Type: String

Valid Values: Disabled | Enabled

Required: No

UserSettings

Contents

See Also