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

Class CfnPortalPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.workspacesweb.CfnPortalPropsMixin

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.363Z")
@Stability(Stable)
public class CfnPortalPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.workspacesweb.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnPortalPropsMixin cfnPortalPropsMixin = CfnPortalPropsMixin.Builder.create(CfnPortalMixinProps.builder()
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .authenticationType("authenticationType")
         .browserSettingsArn("browserSettingsArn")
         .customerManagedKey("customerManagedKey")
         .dataProtectionSettingsArn("dataProtectionSettingsArn")
         .displayName("displayName")
         .instanceType("instanceType")
         .ipAccessSettingsArn("ipAccessSettingsArn")
         .maxConcurrentSessions(123)
         .networkSettingsArn("networkSettingsArn")
         .portalCustomDomain("portalCustomDomain")
         .sessionLoggerArn("sessionLoggerArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trustStoreArn("trustStoreArn")
         .userAccessLoggingSettingsArn("userAccessLoggingSettingsArn")
         .userSettingsArn("userSettingsArn")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnPortalPropsMixin.Builder	A fluent builder for CfnPortalPropsMixin.

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
	CfnPortalPropsMixin(CfnPortalMixinProps props)	Create a mixin to apply properties to AWS::WorkSpacesWeb::Portal.
	CfnPortalPropsMixin(CfnPortalMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::WorkSpacesWeb::Portal.
protected	CfnPortalPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPortalPropsMixin(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 CfnPortalMixinProps	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

CfnPortalPropsMixin

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

CfnPortalPropsMixin

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

CfnPortalPropsMixin

@Stability(Stable)
public CfnPortalPropsMixin(@NotNull
 CfnPortalMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

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

Parameters:

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

options - Mixin options.

CfnPortalPropsMixin

@Stability(Stable)
public CfnPortalPropsMixin(@NotNull
 CfnPortalMixinProps props)

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

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 CfnPortalMixinProps getProps()

getStrategy

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