Package software.amazon.awscdk.services.workspacesweb

Class CfnUserSettings

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.workspacesweb.CfnUserSettings

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IUserSettingsRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:16.153Z")
@Stability(Stable)
public class CfnUserSettings
extends CfnResource
implements IInspectable, IUserSettingsRef, ITaggableV2

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.

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.*;
 CfnUserSettings cfnUserSettings = CfnUserSettings.Builder.create(this, "MyCfnUserSettings")
         .copyAllowed("copyAllowed")
         .downloadAllowed("downloadAllowed")
         .pasteAllowed("pasteAllowed")
         .printAllowed("printAllowed")
         .uploadAllowed("uploadAllowed")
         // the properties below are optional
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .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	Class	Description
static final class	CfnUserSettings.Builder	A fluent builder for CfnUserSettings.
static interface	CfnUserSettings.CookieSpecificationProperty	Specifies a single cookie or set of cookies in an end user's browser.
static interface	CfnUserSettings.CookieSynchronizationConfigurationProperty	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
static interface	CfnUserSettings.ToolbarConfigurationProperty	The configuration of the toolbar.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.workspacesweb.IUserSettingsRef

IUserSettingsRef.Jsii$Default, IUserSettingsRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUserSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserSettings(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUserSettings(software.constructs.Construct scope, String id, CfnUserSettingsProps props)	Create a new AWS::WorkSpacesWeb::UserSettings.

Method Summary

Modifier and Type	Method	Description
Object	getAdditionalEncryptionContext()	The additional encryption context of the user settings.
List<String>	getAttrAssociatedPortalArns()	A list of web portal ARNs that this user settings resource is associated with.
String	getAttrUserSettingsArn()	The ARN of the user settings.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
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.
String	getCustomerManagedKey()	The customer managed key used to encrypt sensitive information in the user settings.
String	getDeepLinkAllowed()	Specifies whether the user can use deep links that open automatically when connecting to a session.
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.
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.
List<CfnTag>	getTags()	The tags to add to the user settings resource.
Object	getToolbarConfiguration()	The configuration of the toolbar.
String	getUploadAllowed()	Specifies whether the user can upload files from the local device to the streaming session.
UserSettingsReference	getUserSettingsRef()	A reference to a UserSettings resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalEncryptionContext(Map<String,String> value)	The additional encryption context of the user settings.
void	setAdditionalEncryptionContext(IResolvable value)	The additional encryption context of the user settings.
void	setCookieSynchronizationConfiguration(IResolvable value)	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
void	setCookieSynchronizationConfiguration(CfnUserSettings.CookieSynchronizationConfigurationProperty value)	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
void	setCopyAllowed(String value)	Specifies whether the user can copy text from the streaming session to the local device.
void	setCustomerManagedKey(String value)	The customer managed key used to encrypt sensitive information in the user settings.
void	setDeepLinkAllowed(String value)	Specifies whether the user can use deep links that open automatically when connecting to a session.
void	setDisconnectTimeoutInMinutes(Number value)	The amount of time that a streaming session remains active after users disconnect.
void	setDownloadAllowed(String value)	Specifies whether the user can download files from the streaming session to the local device.
void	setIdleDisconnectTimeoutInMinutes(Number value)	The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
void	setPasteAllowed(String value)	Specifies whether the user can paste text from the local device to the streaming session.
void	setPrintAllowed(String value)	Specifies whether the user can print to the local device.
void	setTags(List<CfnTag> value)	The tags to add to the user settings resource.
void	setToolbarConfiguration(IResolvable value)	The configuration of the toolbar.
void	setToolbarConfiguration(CfnUserSettings.ToolbarConfigurationProperty value)	The configuration of the toolbar.
void	setUploadAllowed(String value)	Specifies whether the user can upload files from the local device to the streaming session.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnUserSettings

protected CfnUserSettings(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserSettings

protected CfnUserSettings(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserSettings

@Stability(Stable)
public CfnUserSettings(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnUserSettingsProps props)

Create a new AWS::WorkSpacesWeb::UserSettings.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAssociatedPortalArns

@Stability(Stable)
@NotNull
public List<String> getAttrAssociatedPortalArns()

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

getAttrUserSettingsArn

@Stability(Stable)
@NotNull
public String getAttrUserSettingsArn()

The ARN of the user settings.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getUserSettingsRef

@Stability(Stable)
@NotNull
public UserSettingsReference getUserSettingsRef()

A reference to a UserSettings resource.

Specified by:

getUserSettingsRef in interface IUserSettingsRef

getCopyAllowed

@Stability(Stable)
@NotNull
public String getCopyAllowed()

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

setCopyAllowed

@Stability(Stable)
public void setCopyAllowed(@NotNull
 String value)

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

getDownloadAllowed

@Stability(Stable)
@NotNull
public String getDownloadAllowed()

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

setDownloadAllowed

@Stability(Stable)
public void setDownloadAllowed(@NotNull
 String value)

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

getPasteAllowed

@Stability(Stable)
@NotNull
public String getPasteAllowed()

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

setPasteAllowed

@Stability(Stable)
public void setPasteAllowed(@NotNull
 String value)

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

getPrintAllowed

@Stability(Stable)
@NotNull
public String getPrintAllowed()

Specifies whether the user can print to the local device.

setPrintAllowed

@Stability(Stable)
public void setPrintAllowed(@NotNull
 String value)

Specifies whether the user can print to the local device.

getUploadAllowed

@Stability(Stable)
@NotNull
public String getUploadAllowed()

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

setUploadAllowed

@Stability(Stable)
public void setUploadAllowed(@NotNull
 String value)

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

getAdditionalEncryptionContext

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

The additional encryption context of the user settings.

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

setAdditionalEncryptionContext

@Stability(Stable)
public void setAdditionalEncryptionContext(@Nullable
 Map<String,String> value)

The additional encryption context of the user settings.

setAdditionalEncryptionContext

@Stability(Stable)
public void setAdditionalEncryptionContext(@Nullable
 IResolvable value)

The additional encryption context of the user settings.

getCookieSynchronizationConfiguration

@Stability(Stable)
@Nullable
public 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

setCookieSynchronizationConfiguration

@Stability(Stable)
public void setCookieSynchronizationConfiguration(@Nullable
 IResolvable value)

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

setCookieSynchronizationConfiguration

@Stability(Stable)
public void setCookieSynchronizationConfiguration(@Nullable
 CfnUserSettings.CookieSynchronizationConfigurationProperty value)

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

getCustomerManagedKey

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

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

setCustomerManagedKey

@Stability(Stable)
public void setCustomerManagedKey(@Nullable
 String value)

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

getDeepLinkAllowed

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

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

setDeepLinkAllowed

@Stability(Stable)
public void setDeepLinkAllowed(@Nullable
 String value)

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

getDisconnectTimeoutInMinutes

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

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

setDisconnectTimeoutInMinutes

@Stability(Stable)
public void setDisconnectTimeoutInMinutes(@Nullable
 Number value)

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

getIdleDisconnectTimeoutInMinutes

@Stability(Stable)
@Nullable
public 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.

setIdleDisconnectTimeoutInMinutes

@Stability(Stable)
public void setIdleDisconnectTimeoutInMinutes(@Nullable
 Number value)

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

getTags

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

The tags to add to the user settings resource.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

The tags to add to the user settings resource.

getToolbarConfiguration

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

The configuration of the toolbar.

Returns union: either IResolvable or CfnUserSettings.ToolbarConfigurationProperty

setToolbarConfiguration

@Stability(Stable)
public void setToolbarConfiguration(@Nullable
 IResolvable value)

The configuration of the toolbar.

setToolbarConfiguration

@Stability(Stable)
public void setToolbarConfiguration(@Nullable
 CfnUserSettings.ToolbarConfigurationProperty value)

The configuration of the toolbar.