Package software.amazon.awscdk.services.workspacesweb

Class CfnBrowserSettings

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.CfnBrowserSettings
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IBrowserSettingsRef, 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.118Z") @Stability(Stable) public class CfnBrowserSettings extends CfnResource implements IInspectable, IBrowserSettingsRef, ITaggableV2
This resource specifies browser settings that can be associated with a web portal.

Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.

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.*;
 CfnBrowserSettings cfnBrowserSettings = CfnBrowserSettings.Builder.create(this, "MyCfnBrowserSettings")
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .browserPolicy("browserPolicy")
         .customerManagedKey("customerManagedKey")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnBrowserSettings

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

    • CfnBrowserSettings

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

    • CfnBrowserSettings

      @Stability(Stable) public CfnBrowserSettings(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnBrowserSettingsProps props)
      Create a new AWS::WorkSpacesWeb::BrowserSettings.

      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.

    • CfnBrowserSettings

      @Stability(Stable) public CfnBrowserSettings(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::WorkSpacesWeb::BrowserSettings.

      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.

  • 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 the browser settings resource is associated with.

    • getAttrBrowserSettingsArn

      @Stability(Stable) @NotNull public String getAttrBrowserSettingsArn()
      The ARN of the browser settings.

    • getBrowserSettingsRef

      @Stability(Stable) @NotNull public BrowserSettingsReference getBrowserSettingsRef()
      A reference to a BrowserSettings resource.
      Specified by:
      getBrowserSettingsRef in interface IBrowserSettingsRef

    • 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

    • getAdditionalEncryptionContext

      @Stability(Stable) @Nullable public Object getAdditionalEncryptionContext()
      Additional encryption context of the browser settings.

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

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable Map<String,String> value)
      Additional encryption context of the browser settings.

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable IResolvable value)
      Additional encryption context of the browser settings.

    • getBrowserPolicy

      @Stability(Stable) @Nullable public String getBrowserPolicy()
      A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

    • setBrowserPolicy

      @Stability(Stable) public void setBrowserPolicy(@Nullable String value)
      A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

    • getCustomerManagedKey

      @Stability(Stable) @Nullable public String getCustomerManagedKey()
      The custom managed key of the browser settings.

    • setCustomerManagedKey

      @Stability(Stable) public void setCustomerManagedKey(@Nullable String value)
      The custom managed key of the browser settings.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to the browser settings resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to add to the browser settings resource.