AWS::WorkSpacesWeb::UserSettings - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::WorkSpacesWeb::UserSettings

This resource specifies user settings 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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::WorkSpacesWeb::UserSettings",
  "Properties" : {
      "AdditionalEncryptionContext" : {Key: Value, ...},
      "CookieSynchronizationConfiguration" : CookieSynchronizationConfiguration,
      "CopyAllowed" : String,
      "CustomerManagedKey" : String,
      "DeepLinkAllowed" : String,
      "DisconnectTimeoutInMinutes" : Number,
      "DownloadAllowed" : String,
      "IdleDisconnectTimeoutInMinutes" : Number,
      "PasteAllowed" : String,
      "PrintAllowed" : String,
      "Tags" : [ Tag, ... ],
      "ToolbarConfiguration" : ToolbarConfiguration,
      "UploadAllowed" : String
    }
}

Properties

AdditionalEncryptionContext

The additional encryption context of the user settings.

Required: No

Type: Object of String

Pattern: ^[\s\S]*$

Minimum: 0

Maximum: 131072

Update requires: No interruption

CookieSynchronizationConfiguration

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

Required: No

Type: CookieSynchronizationConfiguration

Update requires: No interruption

CopyAllowed

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

Required: Yes

Type: String

Allowed values: Disabled | Enabled

Update requires: No interruption

CustomerManagedKey

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

Required: No

Type: String

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

Minimum: 20

Maximum: 2048

Update requires: No interruption

DeepLinkAllowed

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

Required: No

Type: String

Allowed values: Disabled | Enabled

Update requires: No interruption

DisconnectTimeoutInMinutes

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

Required: No

Type: Number

Minimum: 1

Maximum: 600

Update requires: No interruption

DownloadAllowed

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

Required: Yes

Type: String

Allowed values: Disabled | Enabled

Update requires: No interruption

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.

Required: No

Type: Number

Minimum: 0

Maximum: 60

Update requires: No interruption

PasteAllowed

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

Required: Yes

Type: String

Allowed values: Disabled | Enabled

Update requires: No interruption

PrintAllowed

Specifies whether the user can print to the local device.

Required: Yes

Type: String

Allowed values: Disabled | Enabled

Update requires: No interruption

Tags

The tags to add to the user settings resource. A tag is a key-value pair.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

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.

Required: No

Type: ToolbarConfiguration

Update requires: No interruption

UploadAllowed

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

Required: Yes

Type: String

Allowed values: Disabled | Enabled

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource's Amazon Resource Name (ARN).

For more information about using the Ref function, see Ref.

Fn::GetAtt

AssociatedPortalArns

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

UserSettingsArn

The ARN of the user settings.