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 -
Method Summary
Modifier and TypeMethodDescriptionadditionalEncryptionContext(Map<String, String> additionalEncryptionContext) Sets the value ofCfnPortalMixinProps.getAdditionalEncryptionContext()additionalEncryptionContext(IResolvable additionalEncryptionContext) Sets the value ofCfnPortalMixinProps.getAdditionalEncryptionContext()authenticationType(String authenticationType) Sets the value ofCfnPortalMixinProps.getAuthenticationType()browserSettingsArn(String browserSettingsArn) Sets the value ofCfnPortalMixinProps.getBrowserSettingsArn()build()Builds the configured instance.customerManagedKey(String customerManagedKey) Sets the value ofCfnPortalMixinProps.getCustomerManagedKey()dataProtectionSettingsArn(String dataProtectionSettingsArn) Sets the value ofCfnPortalMixinProps.getDataProtectionSettingsArn()displayName(String displayName) Sets the value ofCfnPortalMixinProps.getDisplayName()instanceType(String instanceType) Sets the value ofCfnPortalMixinProps.getInstanceType()ipAccessSettingsArn(String ipAccessSettingsArn) Sets the value ofCfnPortalMixinProps.getIpAccessSettingsArn()maxConcurrentSessions(Number maxConcurrentSessions) Sets the value ofCfnPortalMixinProps.getMaxConcurrentSessions()networkSettingsArn(String networkSettingsArn) Sets the value ofCfnPortalMixinProps.getNetworkSettingsArn()portalCustomDomain(String portalCustomDomain) Sets the value ofCfnPortalMixinProps.getPortalCustomDomain()sessionLoggerArn(String sessionLoggerArn) Sets the value ofCfnPortalMixinProps.getSessionLoggerArn()Sets the value ofCfnPortalMixinProps.getTags()trustStoreArn(String trustStoreArn) Sets the value ofCfnPortalMixinProps.getTrustStoreArn()userAccessLoggingSettingsArn(String userAccessLoggingSettingsArn) Sets the value ofCfnPortalMixinProps.getUserAccessLoggingSettingsArn()userSettingsArn(String userSettingsArn) Sets the value ofCfnPortalMixinProps.getUserSettingsArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
additionalEncryptionContext
@Stability(Stable) public CfnPortalMixinProps.Builder additionalEncryptionContext(Map<String, String> additionalEncryptionContext) Sets the value ofCfnPortalMixinProps.getAdditionalEncryptionContext()- Parameters:
additionalEncryptionContext- The additional encryption context of the portal.- Returns:
this
-
additionalEncryptionContext
@Stability(Stable) public CfnPortalMixinProps.Builder additionalEncryptionContext(IResolvable additionalEncryptionContext) Sets the value ofCfnPortalMixinProps.getAdditionalEncryptionContext()- Parameters:
additionalEncryptionContext- The additional encryption context of the portal.- Returns:
this
-
authenticationType
Sets the value ofCfnPortalMixinProps.getAuthenticationType()- Parameters:
authenticationType- The type of authentication integration points used when signing into the web portal. Defaults toStandard.Standardweb 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:- Create and deploy a CloudFormation template with a
Standardportal with noIdentityProviderresource. - Retrieve the SP metadata using
Fn:GetAtt, the WorkSpaces Secure Browser console, or by the calling theGetPortalServiceProviderMetadataAPI. - Submit the data to your IdP.
- Add an
IdentityProviderresource to your CloudFormation template.
SSOweb 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.- Create and deploy a CloudFormation template with a
- Returns:
this
-
browserSettingsArn
Sets the value ofCfnPortalMixinProps.getBrowserSettingsArn()- Parameters:
browserSettingsArn- The ARN of the browser settings that is associated with this web portal.- Returns:
this
-
customerManagedKey
Sets the value ofCfnPortalMixinProps.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 ofCfnPortalMixinProps.getDataProtectionSettingsArn()- Parameters:
dataProtectionSettingsArn- The ARN of the data protection settings.- Returns:
this
-
displayName
Sets the value ofCfnPortalMixinProps.getDisplayName()- Parameters:
displayName- The name of the web portal.- Returns:
this
-
instanceType
Sets the value ofCfnPortalMixinProps.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 ofCfnPortalMixinProps.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 ofCfnPortalMixinProps.getMaxConcurrentSessions()- Parameters:
maxConcurrentSessions- The maximum number of concurrent sessions for the portal.- Returns:
this
-
networkSettingsArn
Sets the value ofCfnPortalMixinProps.getNetworkSettingsArn()- Parameters:
networkSettingsArn- The ARN of the network settings that is associated with the web portal.- Returns:
this
-
portalCustomDomain
Sets the value ofCfnPortalMixinProps.getPortalCustomDomain()- Parameters:
portalCustomDomain- the value to be set.- Returns:
this
-
sessionLoggerArn
Sets the value ofCfnPortalMixinProps.getSessionLoggerArn()- Parameters:
sessionLoggerArn- The ARN of the session logger that is associated with the portal.- Returns:
this
-
tags
Sets the value ofCfnPortalMixinProps.getTags()- Parameters:
tags- The tags to add to the web portal. A tag is a key-value pair.- Returns:
this
-
trustStoreArn
Sets the value ofCfnPortalMixinProps.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 ofCfnPortalMixinProps.getUserAccessLoggingSettingsArn()- Parameters:
userAccessLoggingSettingsArn- The ARN of the user access logging settings that is associated with the web portal.- Returns:
this
-
userSettingsArn
Sets the value ofCfnPortalMixinProps.getUserSettingsArn()- Parameters:
userSettingsArn- The ARN of the user settings that is associated with the web portal.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnPortalMixinProps>- Returns:
- a new instance of
CfnPortalMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-