Package software.amazon.awscdk.cfnpropertymixins.services.workspacesweb

Class CfnUserSettingsPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.workspacesweb.CfnUserSettingsPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:06.383Z")
@Stability(Stable)
public class CfnUserSettingsPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.workspacesweb.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnUserSettingsPropsMixin cfnUserSettingsPropsMixin = CfnUserSettingsPropsMixin.Builder.create(CfnUserSettingsMixinProps.builder()
         .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")
                                 .contactButtonText("contactButtonText")
                                 .contactLink("contactLink")
                                 .loadingText("loadingText")
                                 .loginButtonText("loginButtonText")
                                 .loginDescription("loginDescription")
                                 .loginTitle("loginTitle")
                                 .welcomeText("welcomeText")
                                 .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")
                         .name("name")
                         .path("path")
                         .build()))
                 .blocklist(List.of(CookieSpecificationProperty.builder()
                         .domain("domain")
                         .name("name")
                         .path("path")
                         .build()))
                 .build())
         .copyAllowed("copyAllowed")
         .customerManagedKey("customerManagedKey")
         .deepLinkAllowed("deepLinkAllowed")
         .disconnectTimeoutInMinutes(123)
         .downloadAllowed("downloadAllowed")
         .idleDisconnectTimeoutInMinutes(123)
         .pasteAllowed("pasteAllowed")
         .printAllowed("printAllowed")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .toolbarConfiguration(ToolbarConfigurationProperty.builder()
                 .hiddenToolbarItems(List.of("hiddenToolbarItems"))
                 .maxDisplayResolution("maxDisplayResolution")
                 .toolbarType("toolbarType")
                 .visualMode("visualMode")
                 .build())
         .uploadAllowed("uploadAllowed")
         .webAuthnAllowed("webAuthnAllowed")
         .build())
 .strategy(mergeStrategy)
 .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 interface	CfnUserSettingsPropsMixin.BrandingConfigurationProperty	The branding configuration that customizes the appearance of the web portal for end users.
static final class	CfnUserSettingsPropsMixin.Builder	A fluent builder for CfnUserSettingsPropsMixin.
static interface	CfnUserSettingsPropsMixin.CookieSpecificationProperty	Specifies a single cookie or set of cookies in an end user's browser.
static interface	CfnUserSettingsPropsMixin.CookieSynchronizationConfigurationProperty	The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
static interface	CfnUserSettingsPropsMixin.ImageMetadataProperty	Metadata information about an uploaded image file.
static interface	CfnUserSettingsPropsMixin.LocalizedBrandingStringsProperty	Localized text strings for a specific language that customize the web portal.
static interface	CfnUserSettingsPropsMixin.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.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnUserSettingsPropsMixin(CfnUserSettingsMixinProps props)	Create a mixin to apply properties to AWS::WorkSpacesWeb::UserSettings.
	CfnUserSettingsPropsMixin(CfnUserSettingsMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::WorkSpacesWeb::UserSettings.
protected	CfnUserSettingsPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserSettingsPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnUserSettingsMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnUserSettingsPropsMixin

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

CfnUserSettingsPropsMixin

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

CfnUserSettingsPropsMixin

@Stability(Stable)
public CfnUserSettingsPropsMixin(@NotNull
 CfnUserSettingsMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::WorkSpacesWeb::UserSettings.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnUserSettingsPropsMixin

@Stability(Stable)
public CfnUserSettingsPropsMixin(@NotNull
 CfnUserSettingsMixinProps props)

Create a mixin to apply properties to AWS::WorkSpacesWeb::UserSettings.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnUserSettingsMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()