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.
Contents
- 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
- 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
-
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 | EnabledRequired: 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 | EnabledRequired: 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 | EnabledRequired: No
- printAllowed
-
Specifies whether the user can print to the local device.
Type: String
Valid Values:
Disabled | EnabledRequired: No
- uploadAllowed
-
Specifies whether the user can upload files from the local device to the streaming session.
Type: String
Valid Values:
Disabled | EnabledRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
