CfnPortalProps Struct
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 { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const cfnPortalProps: workspacesweb.CfnPortalProps = {
additionalEncryptionContext: {
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: [{
key: 'key',
value: 'value',
}],
trustStoreArn: 'trustStoreArn',
userAccessLoggingSettingsArn: 'userAccessLoggingSettingsArn',
userSettingsArn: 'userSettingsArn',
};
Properties
additionalEncryptionContextoptionalIResolvable | { [key: string]: string }additional_encryption_contextoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]additionalEncryptionContextoptionalIResolvableAdditionalEncryptionContextoptionalIResolvableAdditionalEncryptionContextoptionalinterface{}#authenticationTypeoptionalstringauthentication_typeoptionalstrauthenticationTypeoptionalStringAuthenticationTypeoptionalstringAuthenticationTypeoptional*string#notes
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:
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.
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.
browserSettingsArnoptionalstringbrowser_settings_arnoptionalstrbrowserSettingsArnoptionalStringBrowserSettingsArnoptionalstringBrowserSettingsArnoptional*string#customerManagedKeyoptionalstringcustomer_managed_keyoptionalstrcustomerManagedKeyoptionalStringCustomerManagedKeyoptionalstringCustomerManagedKeyoptional*string#Pattern : ^arn:[\w+=\/,.@-]+:kms:[a-zA-Z0-9\-]*:[a-zA-Z0-9]{1,12}:key\/[a-zA-Z0-9-]+$
dataProtectionSettingsArnoptionalstringdata_protection_settings_arnoptionalstrdataProtectionSettingsArnoptionalStringDataProtectionSettingsArnoptionalstringDataProtectionSettingsArnoptional*string#displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#instanceTypeoptionalstringinstance_typeoptionalstrinstanceTypeoptionalStringInstanceTypeoptionalstringInstanceTypeoptional*string#ipAccessSettingsArnoptionalstringip_access_settings_arnoptionalstripAccessSettingsArnoptionalStringIpAccessSettingsArnoptionalstringIpAccessSettingsArnoptional*string#maxConcurrentSessionsoptionalnumbermax_concurrent_sessionsoptionalint | floatmaxConcurrentSessionsoptionalNumberMaxConcurrentSessionsoptionaldoubleMaxConcurrentSessionsoptional*float64#networkSettingsArnoptionalstringnetwork_settings_arnoptionalstrnetworkSettingsArnoptionalStringNetworkSettingsArnoptionalstringNetworkSettingsArnoptional*string#portalCustomDomainoptionalstringportal_custom_domainoptionalstrportalCustomDomainoptionalStringPortalCustomDomainoptionalstringPortalCustomDomainoptional*string#sessionLoggerArnoptionalstringsession_logger_arnoptionalstrsessionLoggerArnoptionalStringSessionLoggerArnoptionalstringSessionLoggerArnoptional*string#tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#A tag is a key-value pair.
trustStoreArnoptionalstringtrust_store_arnoptionalstrtrustStoreArnoptionalStringTrustStoreArnoptionalstringTrustStoreArnoptional*string#userAccessLoggingSettingsArnoptionalstringuser_access_logging_settings_arnoptionalstruserAccessLoggingSettingsArnoptionalStringUserAccessLoggingSettingsArnoptionalstringUserAccessLoggingSettingsArnoptional*string#userSettingsArnoptionalstringuser_settings_arnoptionalstruserSettingsArnoptionalStringUserSettingsArnoptionalstringUserSettingsArnoptional*string#