Package software.amazon.awscdk.services.workspacesweb

Class CfnPortal

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.CfnPortal
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPortalRef, 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.144Z") @Stability(Stable) public class CfnPortal extends CfnResource implements IInspectable, IPortalRef, ITaggableV2
This resource specifies a web portal, which users use to start browsing sessions.

A Standard web portal can't start browsing sessions unless you have at defined and associated an IdentityProvider and NetworkSettings resource. An IAM Identity Center web portal does not require an IdentityProvider resource.

For more information about web portals, see What is Amazon WorkSpaces Secure Browser? .

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.*;
 CfnPortal cfnPortal = CfnPortal.Builder.create(this, "MyCfnPortal")
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .authenticationType("authenticationType")
         .browserSettingsArn("browserSettingsArn")
         .customerManagedKey("customerManagedKey")
         .dataProtectionSettingsArn("dataProtectionSettingsArn")
         .displayName("displayName")
         .instanceType("instanceType")
         .ipAccessSettingsArn("ipAccessSettingsArn")
         .maxConcurrentSessions(123)
         .networkSettingsArn("networkSettingsArn")
         .sessionLoggerArn("sessionLoggerArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trustStoreArn("trustStoreArn")
         .userAccessLoggingSettingsArn("userAccessLoggingSettingsArn")
         .userSettingsArn("userSettingsArn")
         .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

    • CfnPortal

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

    • CfnPortal

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

    • CfnPortal

      @Stability(Stable) public CfnPortal(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnPortalProps props)
      Create a new AWS::WorkSpacesWeb::Portal.

      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.

    • CfnPortal

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

      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.

    • getAttrBrowserType

      @Stability(Stable) @NotNull public String getAttrBrowserType()
      The browser that users see when using a streaming session.

    • getAttrCreationDate

      @Stability(Stable) @NotNull public String getAttrCreationDate()
      The creation date of the web portal.

    • getAttrPortalArn

      @Stability(Stable) @NotNull public String getAttrPortalArn()
      The ARN of the web portal.

    • getAttrPortalEndpoint

      @Stability(Stable) @NotNull public String getAttrPortalEndpoint()
      The endpoint URL of the web portal that users access in order to start streaming sessions.

    • getAttrPortalStatus

      @Stability(Stable) @NotNull public String getAttrPortalStatus()
      The status of the web portal.

    • getAttrRendererType

      @Stability(Stable) @NotNull public String getAttrRendererType()
      The renderer that is used in streaming sessions.

    • getAttrServiceProviderSamlMetadata

      @Stability(Stable) @NotNull public String getAttrServiceProviderSamlMetadata()
      The SAML metadata of the service provider.

    • getAttrStatusReason

      @Stability(Stable) @NotNull public String getAttrStatusReason()
      A message that explains why the web portal is in its current status.

    • 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

    • getPortalRef

      @Stability(Stable) @NotNull public PortalReference getPortalRef()
      A reference to a Portal resource.
      Specified by:
      getPortalRef in interface IPortalRef

    • getAdditionalEncryptionContext

      @Stability(Stable) @Nullable public Object getAdditionalEncryptionContext()
      The additional encryption context of the portal.

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

    • setAdditionalEncryptionContext

      @Stability(Stable) public void setAdditionalEncryptionContext(@Nullable IResolvable value)
      The additional encryption context of the portal.

    • getAuthenticationType

      @Stability(Stable) @Nullable public String getAuthenticationType()
      The type of authentication integration points used when signing into the web portal.

      Defaults to Standard .

    • setAuthenticationType

      @Stability(Stable) public void setAuthenticationType(@Nullable String value)
      The type of authentication integration points used when signing into the web portal.

      Defaults to Standard .

    • getBrowserSettingsArn

      @Stability(Stable) @Nullable public String getBrowserSettingsArn()
      The ARN of the browser settings that is associated with this web portal.

    • setBrowserSettingsArn

      @Stability(Stable) public void setBrowserSettingsArn(@Nullable String value)
      The ARN of the browser settings that is associated with this web portal.

    • getCustomerManagedKey

      @Stability(Stable) @Nullable public String getCustomerManagedKey()
      The customer managed key of the web portal.

    • setCustomerManagedKey

      @Stability(Stable) public void setCustomerManagedKey(@Nullable String value)
      The customer managed key of the web portal.

    • getDataProtectionSettingsArn

      @Stability(Stable) @Nullable public String getDataProtectionSettingsArn()
      The ARN of the data protection settings.

    • setDataProtectionSettingsArn

      @Stability(Stable) public void setDataProtectionSettingsArn(@Nullable String value)
      The ARN of the data protection settings.

    • getDisplayName

      @Stability(Stable) @Nullable public String getDisplayName()
      The name of the web portal.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@Nullable String value)
      The name of the web portal.

    • getInstanceType

      @Stability(Stable) @Nullable public String getInstanceType()
      The type and resources of the underlying instance.

    • setInstanceType

      @Stability(Stable) public void setInstanceType(@Nullable String value)
      The type and resources of the underlying instance.

    • getIpAccessSettingsArn

      @Stability(Stable) @Nullable public String getIpAccessSettingsArn()
      The ARN of the IP access settings that is associated with the web portal.

    • setIpAccessSettingsArn

      @Stability(Stable) public void setIpAccessSettingsArn(@Nullable String value)
      The ARN of the IP access settings that is associated with the web portal.

    • getMaxConcurrentSessions

      @Stability(Stable) @Nullable public Number getMaxConcurrentSessions()
      The maximum number of concurrent sessions for the portal.

    • setMaxConcurrentSessions

      @Stability(Stable) public void setMaxConcurrentSessions(@Nullable Number value)
      The maximum number of concurrent sessions for the portal.

    • getNetworkSettingsArn

      @Stability(Stable) @Nullable public String getNetworkSettingsArn()
      The ARN of the network settings that is associated with the web portal.

    • setNetworkSettingsArn

      @Stability(Stable) public void setNetworkSettingsArn(@Nullable String value)
      The ARN of the network settings that is associated with the web portal.

    • getSessionLoggerArn

      @Stability(Stable) @Nullable public String getSessionLoggerArn()
      The ARN of the session logger that is assocaited with the portal.

    • setSessionLoggerArn

      @Stability(Stable) public void setSessionLoggerArn(@Nullable String value)
      The ARN of the session logger that is assocaited with the portal.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to add to the web portal.

    • setTags

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

    • getTrustStoreArn

      @Stability(Stable) @Nullable public String getTrustStoreArn()
      The ARN of the trust store that is associated with the web portal.

    • setTrustStoreArn

      @Stability(Stable) public void setTrustStoreArn(@Nullable String value)
      The ARN of the trust store that is associated with the web portal.

    • getUserAccessLoggingSettingsArn

      @Stability(Stable) @Nullable public String getUserAccessLoggingSettingsArn()
      The ARN of the user access logging settings that is associated with the web portal.

    • setUserAccessLoggingSettingsArn

      @Stability(Stable) public void setUserAccessLoggingSettingsArn(@Nullable String value)
      The ARN of the user access logging settings that is associated with the web portal.

    • getUserSettingsArn

      @Stability(Stable) @Nullable public String getUserSettingsArn()
      The ARN of the user settings that is associated with the web portal.

    • setUserSettingsArn

      @Stability(Stable) public void setUserSettingsArn(@Nullable String value)
      The ARN of the user settings that is associated with the web portal.