AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::WorkSpacesWeb::UserSettings

CfnUserSettings

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.

Import

import { CfnUserSettings } from 'aws-cdk-lib/aws-workspacesweb';

Or use the module namespace:

import * as workspacesweb from 'aws-cdk-lib/aws-workspacesweb';
// workspacesweb.CfnUserSettings

Properties

Configuration passed to the constructor as CfnUserSettingsProps.

copyAllowedRequired
string

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

downloadAllowedRequired
string

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

pasteAllowedRequired
string

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

printAllowedRequired
string

Specifies whether the user can print to the local device.

uploadAllowedRequired
string

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

additionalEncryptionContextOptional
{ [key: string]: string } | IResolvable

The additional encryption context of the user settings.

brandingConfigurationOptional
IResolvable | BrandingConfigurationProperty

The branding configuration that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, wallpaper, localized strings, color theme, and an optional terms of service.

cookieSynchronizationConfigurationOptional
IResolvable | CookieSynchronizationConfigurationProperty

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

customerManagedKeyOptional
string

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

deepLinkAllowedOptional
string

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

disconnectTimeoutInMinutesOptional
number

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

idleDisconnectTimeoutInMinutesOptional
number

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

tagsOptional
CfnTag[]

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

toolbarConfigurationOptional
IResolvable | ToolbarConfigurationProperty

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.

webAuthnAllowedOptional
string

Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::WorkSpacesWeb::UserSettingsView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-workspacesweb
CFN TypeAWS::WorkSpacesWeb::UserSettings
Properties15

Related Constructs

Explore This Service

External Links