Package software.amazon.awscdk.services.workspacesweb

Interface CfnUserSettingsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserSettingsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:19.664Z")
@Stability(Stable)
public interface CfnUserSettingsProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserSettings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.workspacesweb.*;
 CfnUserSettingsProps cfnUserSettingsProps = CfnUserSettingsProps.builder()
         .copyAllowed("copyAllowed")
         .downloadAllowed("downloadAllowed")
         .pasteAllowed("pasteAllowed")
         .printAllowed("printAllowed")
         .uploadAllowed("uploadAllowed")
         // the properties below are optional
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .brandingConfiguration(BrandingConfigurationProperty.builder()
                 .colorTheme("colorTheme")
                 .favicon("favicon")
                 .faviconMetadata(ImageMetadataProperty.builder()
                         .fileExtension("fileExtension")
                         .lastUploadTimestamp("lastUploadTimestamp")
                         .mimeType("mimeType")
                         .build())
                 .localizedStrings(Map.of(
                         "localizedStringsKey", LocalizedBrandingStringsProperty.builder()
                                 .browserTabTitle("browserTabTitle")
                                 .welcomeText("welcomeText")
                                 // the properties below are optional
                                 .contactButtonText("contactButtonText")
                                 .contactLink("contactLink")
                                 .loadingText("loadingText")
                                 .loginButtonText("loginButtonText")
                                 .loginDescription("loginDescription")
                                 .loginTitle("loginTitle")
                                 .build()))
                 .logo("logo")
                 .logoMetadata(ImageMetadataProperty.builder()
                         .fileExtension("fileExtension")
                         .lastUploadTimestamp("lastUploadTimestamp")
                         .mimeType("mimeType")
                         .build())
                 .termsOfService("termsOfService")
                 .wallpaper("wallpaper")
                 .wallpaperMetadata(ImageMetadataProperty.builder()
                         .fileExtension("fileExtension")
                         .lastUploadTimestamp("lastUploadTimestamp")
                         .mimeType("mimeType")
                         .build())
                 .build())
         .cookieSynchronizationConfiguration(CookieSynchronizationConfigurationProperty.builder()
                 .allowlist(List.of(CookieSpecificationProperty.builder()
                         .domain("domain")
                         // the properties below are optional
                         .name("name")
                         .path("path")
                         .build()))
                 // the properties below are optional
                 .blocklist(List.of(CookieSpecificationProperty.builder()
                         .domain("domain")
                         // the properties below are optional
                         .name("name")
                         .path("path")
                         .build()))
                 .build())
         .customerManagedKey("customerManagedKey")
         .deepLinkAllowed("deepLinkAllowed")
         .disconnectTimeoutInMinutes(123)
         .idleDisconnectTimeoutInMinutes(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .toolbarConfiguration(ToolbarConfigurationProperty.builder()
                 .hiddenToolbarItems(List.of("hiddenToolbarItems"))
                 .maxDisplayResolution("maxDisplayResolution")
                 .toolbarType("toolbarType")
                 .visualMode("visualMode")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserSettingsProps.Builder	A builder for CfnUserSettingsProps
static final class	CfnUserSettingsProps.Jsii$Proxy	An implementation for CfnUserSettingsProps

Method Summary

Modifier and Type	Method	Description
static CfnUserSettingsProps.Builder	builder()
default Object	getAdditionalEncryptionContext()	The additional encryption context of the user settings.
default Object	getBrandingConfiguration()	Returns union: either IResolvable or CfnUserSettings.BrandingConfigurationProperty
default Object	getCookieSynchronizationConfiguration()	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
String	getCopyAllowed()	Specifies whether the user can copy text from the streaming session to the local device.
default String	getCustomerManagedKey()	The customer managed key used to encrypt sensitive information in the user settings.
default String	getDeepLinkAllowed()	Specifies whether the user can use deep links that open automatically when connecting to a session.
default Number	getDisconnectTimeoutInMinutes()	The amount of time that a streaming session remains active after users disconnect.
String	getDownloadAllowed()	Specifies whether the user can download files from the streaming session to the local device.
default Number	getIdleDisconnectTimeoutInMinutes()	The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
String	getPasteAllowed()	Specifies whether the user can paste text from the local device to the streaming session.
String	getPrintAllowed()	Specifies whether the user can print to the local device.
default List<CfnTag>	getTags()	The tags to add to the user settings resource.
default Object	getToolbarConfiguration()	The configuration of the toolbar.
String	getUploadAllowed()	Specifies whether the user can upload files from the local device to the streaming session.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCopyAllowed

@Stability(Stable)
@NotNull
String getCopyAllowed()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-copyallowed

getDownloadAllowed

@Stability(Stable)
@NotNull
String getDownloadAllowed()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-downloadallowed

getPasteAllowed

@Stability(Stable)
@NotNull
String getPasteAllowed()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-pasteallowed

getPrintAllowed

@Stability(Stable)
@NotNull
String getPrintAllowed()

Specifies whether the user can print to the local device.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-printallowed

getUploadAllowed

@Stability(Stable)
@NotNull
String getUploadAllowed()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-uploadallowed

getAdditionalEncryptionContext

@Stability(Stable)
@Nullable
default Object getAdditionalEncryptionContext()

The additional encryption context of the user settings.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-additionalencryptioncontext

getBrandingConfiguration

@Stability(Stable)
@Nullable
default Object getBrandingConfiguration()

Returns union: either IResolvable or CfnUserSettings.BrandingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-brandingconfiguration

getCookieSynchronizationConfiguration

@Stability(Stable)
@Nullable
default Object getCookieSynchronizationConfiguration()

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

Returns union: either IResolvable or CfnUserSettings.CookieSynchronizationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration

getCustomerManagedKey

@Stability(Stable)
@Nullable
default String getCustomerManagedKey()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-customermanagedkey

getDeepLinkAllowed

@Stability(Stable)
@Nullable
default String getDeepLinkAllowed()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-deeplinkallowed

getDisconnectTimeoutInMinutes

@Stability(Stable)
@Nullable
default Number getDisconnectTimeoutInMinutes()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-disconnecttimeoutinminutes

getIdleDisconnectTimeoutInMinutes

@Stability(Stable)
@Nullable
default Number getIdleDisconnectTimeoutInMinutes()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-idledisconnecttimeoutinminutes

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to add to the user settings resource.

A tag is a key-value pair.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-tags

getToolbarConfiguration

@Stability(Stable)
@Nullable
default Object getToolbarConfiguration()

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.

Returns union: either IResolvable or CfnUserSettings.ToolbarConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-toolbarconfiguration

builder

@Stability(Stable)
static CfnUserSettingsProps.Builder builder()

Returns:

a CfnUserSettingsProps.Builder of CfnUserSettingsProps