Package software.amazon.awscdk.services.workspacesweb

Interface CfnPortalProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPortalProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.118Z")
@Stability(Stable)
public interface CfnPortalProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPortal.

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.*;
 CfnPortalProps cfnPortalProps = CfnPortalProps.builder()
         .additionalEncryptionContext(Map.of(
                 "additionalEncryptionContextKey", "additionalEncryptionContext"))
         .authenticationType("authenticationType")
         .browserSettingsArn("browserSettingsArn")
         .customerManagedKey("customerManagedKey")
         .displayName("displayName")
         .instanceType("instanceType")
         .ipAccessSettingsArn("ipAccessSettingsArn")
         .maxConcurrentSessions(123)
         .networkSettingsArn("networkSettingsArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trustStoreArn("trustStoreArn")
         .userAccessLoggingSettingsArn("userAccessLoggingSettingsArn")
         .userSettingsArn("userSettingsArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPortalProps.Builder	A builder for CfnPortalProps
static final class	CfnPortalProps.Jsii$Proxy	An implementation for CfnPortalProps

Method Summary

Modifier and Type	Method	Description
static CfnPortalProps.Builder	builder()
default Object	getAdditionalEncryptionContext()	The additional encryption context of the portal.
default String	getAuthenticationType()	The type of authentication integration points used when signing into the web portal.
default String	getBrowserSettingsArn()	The ARN of the browser settings that is associated with this web portal.
default String	getCustomerManagedKey()	The customer managed key of the web portal.
default String	getDisplayName()	The name of the web portal.
default String	getInstanceType()	The type and resources of the underlying instance.
default String	getIpAccessSettingsArn()	The ARN of the IP access settings that is associated with the web portal.
default Number	getMaxConcurrentSessions()	The maximum number of concurrent sessions for the portal.
default String	getNetworkSettingsArn()	The ARN of the network settings that is associated with the web portal.
default List<CfnTag>	getTags()	The tags to add to the web portal.
default String	getTrustStoreArn()	The ARN of the trust store that is associated with the web portal.
default String	getUserAccessLoggingSettingsArn()	The ARN of the user access logging settings that is associated with the web portal.
default String	getUserSettingsArn()	The ARN of the user settings that is associated with the web portal.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalEncryptionContext

@Stability(Stable)
@Nullable
default Object getAdditionalEncryptionContext()

The additional encryption context of the portal.

See Also:

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

getAuthenticationType

@Stability(Stable)
@Nullable
default String getAuthenticationType()

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.

See Also:

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

getBrowserSettingsArn

@Stability(Stable)
@Nullable
default String getBrowserSettingsArn()

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

See Also:

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

getCustomerManagedKey

@Stability(Stable)
@Nullable
default String getCustomerManagedKey()

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

See Also:

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

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

The name of the web portal.

See Also:

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

getInstanceType

@Stability(Stable)
@Nullable
default String getInstanceType()

The type and resources of the underlying instance.

See Also:

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

getIpAccessSettingsArn

@Stability(Stable)
@Nullable
default String getIpAccessSettingsArn()

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

See Also:

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

getMaxConcurrentSessions

@Stability(Stable)
@Nullable
default Number getMaxConcurrentSessions()

The maximum number of concurrent sessions for the portal.

See Also:

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

getNetworkSettingsArn

@Stability(Stable)
@Nullable
default String getNetworkSettingsArn()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to add to the web portal.

A tag is a key-value pair.

See Also:

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

getTrustStoreArn

@Stability(Stable)
@Nullable
default String getTrustStoreArn()

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

See Also:

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

getUserAccessLoggingSettingsArn

@Stability(Stable)
@Nullable
default String getUserAccessLoggingSettingsArn()

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

See Also:

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

getUserSettingsArn

@Stability(Stable)
@Nullable
default String getUserSettingsArn()

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

See Also:

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

builder

@Stability(Stable)
static CfnPortalProps.Builder builder()

Returns:

a CfnPortalProps.Builder of CfnPortalProps