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

Class CfnPortalMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.workspacesweb.CfnPortalMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPortalMixinProps>

Enclosing interface:

CfnPortalMixinProps

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

A builder for CfnPortalMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnPortalMixinProps.Builder	additionalEncryptionContext(Map<String,String> additionalEncryptionContext)	Sets the value of CfnPortalMixinProps.getAdditionalEncryptionContext()
CfnPortalMixinProps.Builder	additionalEncryptionContext(IResolvable additionalEncryptionContext)	Sets the value of CfnPortalMixinProps.getAdditionalEncryptionContext()
CfnPortalMixinProps.Builder	authenticationType(String authenticationType)	Sets the value of CfnPortalMixinProps.getAuthenticationType()
CfnPortalMixinProps.Builder	browserSettingsArn(String browserSettingsArn)	Sets the value of CfnPortalMixinProps.getBrowserSettingsArn()
CfnPortalMixinProps	build()	Builds the configured instance.
CfnPortalMixinProps.Builder	customerManagedKey(String customerManagedKey)	Sets the value of CfnPortalMixinProps.getCustomerManagedKey()
CfnPortalMixinProps.Builder	dataProtectionSettingsArn(String dataProtectionSettingsArn)	Sets the value of CfnPortalMixinProps.getDataProtectionSettingsArn()
CfnPortalMixinProps.Builder	displayName(String displayName)	Sets the value of CfnPortalMixinProps.getDisplayName()
CfnPortalMixinProps.Builder	instanceType(String instanceType)	Sets the value of CfnPortalMixinProps.getInstanceType()
CfnPortalMixinProps.Builder	ipAccessSettingsArn(String ipAccessSettingsArn)	Sets the value of CfnPortalMixinProps.getIpAccessSettingsArn()
CfnPortalMixinProps.Builder	maxConcurrentSessions(Number maxConcurrentSessions)	Sets the value of CfnPortalMixinProps.getMaxConcurrentSessions()
CfnPortalMixinProps.Builder	networkSettingsArn(String networkSettingsArn)	Sets the value of CfnPortalMixinProps.getNetworkSettingsArn()
CfnPortalMixinProps.Builder	portalCustomDomain(String portalCustomDomain)	Sets the value of CfnPortalMixinProps.getPortalCustomDomain()
CfnPortalMixinProps.Builder	sessionLoggerArn(String sessionLoggerArn)	Sets the value of CfnPortalMixinProps.getSessionLoggerArn()
CfnPortalMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnPortalMixinProps.getTags()
CfnPortalMixinProps.Builder	trustStoreArn(String trustStoreArn)	Sets the value of CfnPortalMixinProps.getTrustStoreArn()
CfnPortalMixinProps.Builder	userAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)	Sets the value of CfnPortalMixinProps.getUserAccessLoggingSettingsArn()
CfnPortalMixinProps.Builder	userSettingsArn(String userSettingsArn)	Sets the value of CfnPortalMixinProps.getUserSettingsArn()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

additionalEncryptionContext

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

Sets the value of CfnPortalMixinProps.getAdditionalEncryptionContext()

Parameters:

additionalEncryptionContext - The additional encryption context of the portal.

Returns:

this

additionalEncryptionContext

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

Sets the value of CfnPortalMixinProps.getAdditionalEncryptionContext()

Parameters:

additionalEncryptionContext - The additional encryption context of the portal.

Returns:

this

authenticationType

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

Sets the value of CfnPortalMixinProps.getAuthenticationType()

Parameters:

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 Secure Browser’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 Secure Browser console, or by the calling the GetPortalServiceProviderMetadata API.
3. Submit the data to your IdP.
4. Add an IdentityProvider resource to your CloudFormation template.

SSO web portals are authenticated through SSOlong . 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 SSO . User and group assignment must be done through the WorkSpaces Secure Browser console. These cannot be configured in CloudFormation.

Returns:

this

browserSettingsArn

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

Sets the value of CfnPortalMixinProps.getBrowserSettingsArn()

Parameters:

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

Returns:

this

customerManagedKey

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

Sets the value of CfnPortalMixinProps.getCustomerManagedKey()

Parameters:

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-]+$

Returns:

this

dataProtectionSettingsArn

@Stability(Stable)
public CfnPortalMixinProps.Builder dataProtectionSettingsArn(String dataProtectionSettingsArn)

Sets the value of CfnPortalMixinProps.getDataProtectionSettingsArn()

Parameters:

dataProtectionSettingsArn - The ARN of the data protection settings.

Returns:

this

displayName

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

Sets the value of CfnPortalMixinProps.getDisplayName()

Parameters:

displayName - The name of the web portal.

Returns:

this

instanceType

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

Sets the value of CfnPortalMixinProps.getInstanceType()

Parameters:

instanceType - The type and resources of the underlying instance.

Returns:

this

ipAccessSettingsArn

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

Sets the value of CfnPortalMixinProps.getIpAccessSettingsArn()

Parameters:

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

Returns:

this

maxConcurrentSessions

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

Sets the value of CfnPortalMixinProps.getMaxConcurrentSessions()

Parameters:

maxConcurrentSessions - The maximum number of concurrent sessions for the portal.

Returns:

this

networkSettingsArn

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

Sets the value of CfnPortalMixinProps.getNetworkSettingsArn()

Parameters:

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

Returns:

this

portalCustomDomain

@Stability(Stable)
public CfnPortalMixinProps.Builder portalCustomDomain(String portalCustomDomain)

Sets the value of CfnPortalMixinProps.getPortalCustomDomain()

Parameters:

portalCustomDomain - the value to be set.

Returns:

this

sessionLoggerArn

@Stability(Stable)
public CfnPortalMixinProps.Builder sessionLoggerArn(String sessionLoggerArn)

Sets the value of CfnPortalMixinProps.getSessionLoggerArn()

Parameters:

sessionLoggerArn - The ARN of the session logger that is associated with the portal.

Returns:

this

tags

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

Sets the value of CfnPortalMixinProps.getTags()

Parameters:

tags - The tags to add to the web portal. A tag is a key-value pair.

Returns:

this

trustStoreArn

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

Sets the value of CfnPortalMixinProps.getTrustStoreArn()

Parameters:

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

Returns:

this

userAccessLoggingSettingsArn

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

Sets the value of CfnPortalMixinProps.getUserAccessLoggingSettingsArn()

Parameters:

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

Returns:

this

userSettingsArn

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

Sets the value of CfnPortalMixinProps.getUserSettingsArn()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnPortalMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnPortalMixinProps

Throws:

NullPointerException - if any required attribute was not provided