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.125.0 (build fdbe357)", date="2026-01-23T11:19:56.683Z") @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"))
         .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())
         .webAuthnAllowed("webAuthnAllowed")
         .build();

See Also:

  • 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

    • arnForUserSettings

      @Stability(Stable) @NotNull public static String arnForUserSettings(@NotNull IUserSettingsRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnUserSettings

      @Stability(Stable) @NotNull public static Boolean isCfnUserSettings(@NotNull Object x)
      Checks whether the given object is a CfnUserSettings.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrBrandingConfigurationFaviconMetadata

      @Stability(Stable) @NotNull public IResolvable getAttrBrandingConfigurationFaviconMetadata()
      Read-only.

      Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

    • getAttrBrandingConfigurationLogoMetadata

      @Stability(Stable) @NotNull public IResolvable getAttrBrandingConfigurationLogoMetadata()
      Read-only.

      Metadata for the logo image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

    • getAttrBrandingConfigurationWallpaperMetadata

      @Stability(Stable) @NotNull public IResolvable getAttrBrandingConfigurationWallpaperMetadata()
      Read-only.

      Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

    • 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.

    • getBrandingConfiguration

      @Stability(Stable) @Nullable public Object getBrandingConfiguration()
      The branding configuration that customizes the appearance of the web portal for end users.

      Returns union: either IResolvable or CfnUserSettings.BrandingConfigurationProperty

    • setBrandingConfiguration

      @Stability(Stable) public void setBrandingConfiguration(@Nullable IResolvable value)
      The branding configuration that customizes the appearance of the web portal for end users.

    • setBrandingConfiguration

      @Stability(Stable) public void setBrandingConfiguration(@Nullable CfnUserSettings.BrandingConfigurationProperty value)
      The branding configuration that customizes the appearance of the web portal for end users.

    • 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.

    • getWebAuthnAllowed

      @Stability(Stable) @Nullable public String getWebAuthnAllowed()
      Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

    • setWebAuthnAllowed

      @Stability(Stable) public void setWebAuthnAllowed(@Nullable String value)
      Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.