Package software.amazon.awscdk.services.workspacesweb

Class CfnPortal.Builder

java.lang.Object

software.amazon.awscdk.services.workspacesweb.CfnPortal.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPortal>

Enclosing class:

CfnPortal

@Stability(Stable)
public static final class CfnPortal.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPortal>

A fluent builder for CfnPortal.

Method Summary

Modifier and Type	Method	Description
CfnPortal.Builder	additionalEncryptionContext(Map<String,String> additionalEncryptionContext)	The additional encryption context of the portal.
CfnPortal.Builder	additionalEncryptionContext(IResolvable additionalEncryptionContext)	The additional encryption context of the portal.
CfnPortal.Builder	authenticationType(String authenticationType)	The type of authentication integration points used when signing into the web portal.
CfnPortal.Builder	browserSettingsArn(String browserSettingsArn)	The ARN of the browser settings that is associated with this web portal.
CfnPortal	build()
static CfnPortal.Builder	create(software.constructs.Construct scope, String id)
CfnPortal.Builder	customerManagedKey(String customerManagedKey)	The customer managed key of the web portal.
CfnPortal.Builder	displayName(String displayName)	The name of the web portal.
CfnPortal.Builder	instanceType(String instanceType)	The type and resources of the underlying instance.
CfnPortal.Builder	ipAccessSettingsArn(String ipAccessSettingsArn)	The ARN of the IP access settings that is associated with the web portal.
CfnPortal.Builder	maxConcurrentSessions(Number maxConcurrentSessions)	The maximum number of concurrent sessions for the portal.
CfnPortal.Builder	networkSettingsArn(String networkSettingsArn)	The ARN of the network settings that is associated with the web portal.
CfnPortal.Builder	tags(List<? extends CfnTag> tags)	The tags to add to the web portal.
CfnPortal.Builder	trustStoreArn(String trustStoreArn)	The ARN of the trust store that is associated with the web portal.
CfnPortal.Builder	userAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)	The ARN of the user access logging settings that is associated with the web portal.
CfnPortal.Builder	userSettingsArn(String userSettingsArn)	The ARN of the user settings that is associated with the web portal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPortal.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnPortal.Builder.

additionalEncryptionContext

@Stability(Stable)
public CfnPortal.Builder additionalEncryptionContext(IResolvable additionalEncryptionContext)

The additional encryption context of the portal.

Parameters:

additionalEncryptionContext - The additional encryption context of the portal. This parameter is required.

Returns:

this

See Also:

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

additionalEncryptionContext

@Stability(Stable)
public CfnPortal.Builder additionalEncryptionContext(Map<String,String> additionalEncryptionContext)

The additional encryption context of the portal.

Parameters:

additionalEncryptionContext - The additional encryption context of the portal. This parameter is required.

Returns:

this

See Also:

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

authenticationType

@Stability(Stable)
public CfnPortal.Builder authenticationType(String authenticationType)

The type of authentication integration points used when signing into the web portal. Defaults to Standard .

Standard web portals are authenticated directly through your identity provider (IdP). User and group access to your web portal is controlled through your IdP. You need to include an IdP resource in your template to integrate your IdP with your web portal. Completing the configuration for your IdP requires exchanging WorkSpaces Web’s SP metadata with your IdP’s IdP metadata. If your IdP requires the SP metadata first before returning the IdP metadata, you should follow these steps:

1. Create and deploy a CloudFormation template with a Standard portal with no IdentityProvider resource.
2. Retrieve the SP metadata using Fn:GetAtt , the WorkSpaces Web console, or by the calling the GetPortalServiceProviderMetadata API.
3. Submit the data to your IdP.
4. Add an IdentityProvider resource to your CloudFormation template.

IAM Identity Center web portals are authenticated through AWS IAM Identity Center . They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration) and other identity provider information must be configured in IAM Identity Center . User and group assignment must be done through the WorkSpaces Web console. These cannot be configured in CloudFormation.

Parameters:

authenticationType - The type of authentication integration points used when signing into the web portal. Defaults to Standard . This parameter is required.

Returns:

this

See Also:

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

browserSettingsArn

@Stability(Stable)
public CfnPortal.Builder browserSettingsArn(String browserSettingsArn)

The ARN of the browser settings that is associated with this web portal.

Parameters:

browserSettingsArn - The ARN of the browser settings that is associated with this web portal. This parameter is required.

Returns:

this

See Also:

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

customerManagedKey

@Stability(Stable)
public CfnPortal.Builder customerManagedKey(String customerManagedKey)

The customer managed key of the web portal.

Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$

Parameters:

customerManagedKey - The customer managed key of the web portal. This parameter is required.

Returns:

this

See Also:

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

displayName

@Stability(Stable)
public CfnPortal.Builder displayName(String displayName)

The name of the web portal.

Parameters:

displayName - The name of the web portal. This parameter is required.

Returns:

this

See Also:

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

instanceType

@Stability(Stable)
public CfnPortal.Builder instanceType(String instanceType)

The type and resources of the underlying instance.

Parameters:

instanceType - The type and resources of the underlying instance. This parameter is required.

Returns:

this

See Also:

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

ipAccessSettingsArn

@Stability(Stable)
public CfnPortal.Builder ipAccessSettingsArn(String ipAccessSettingsArn)

The ARN of the IP access settings that is associated with the web portal.

Parameters:

ipAccessSettingsArn - The ARN of the IP access settings that is associated with the web portal. This parameter is required.

Returns:

this

See Also:

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

maxConcurrentSessions

@Stability(Stable)
public CfnPortal.Builder maxConcurrentSessions(Number maxConcurrentSessions)

The maximum number of concurrent sessions for the portal.

Parameters:

maxConcurrentSessions - The maximum number of concurrent sessions for the portal. This parameter is required.

Returns:

this

See Also:

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

networkSettingsArn

@Stability(Stable)
public CfnPortal.Builder networkSettingsArn(String networkSettingsArn)

The ARN of the network settings that is associated with the web portal.

Parameters:

networkSettingsArn - The ARN of the network settings that is associated with the web portal. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnPortal.Builder tags(List<? extends CfnTag> tags)

The tags to add to the web portal.

A tag is a key-value pair.

Parameters:

tags - The tags to add to the web portal. This parameter is required.

Returns:

this

See Also:

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

trustStoreArn

@Stability(Stable)
public CfnPortal.Builder trustStoreArn(String trustStoreArn)

The ARN of the trust store that is associated with the web portal.

Parameters:

trustStoreArn - The ARN of the trust store that is associated with the web portal. This parameter is required.

Returns:

this

See Also:

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

userAccessLoggingSettingsArn

@Stability(Stable)
public CfnPortal.Builder userAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)

The ARN of the user access logging settings that is associated with the web portal.

Parameters:

userAccessLoggingSettingsArn - The ARN of the user access logging settings that is associated with the web portal. This parameter is required.

Returns:

this

See Also:

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

userSettingsArn

@Stability(Stable)
public CfnPortal.Builder userSettingsArn(String userSettingsArn)

The ARN of the user settings that is associated with the web portal.

Parameters:

userSettingsArn - The ARN of the user settings that is associated with the web portal. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPortal build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPortal>

Returns:

a newly built instance of CfnPortal.