CfnPortalProps

class aws_cdk.aws_workspacesweb.CfnPortalProps(*, additional_encryption_context=None, authentication_type=None, browser_settings_arn=None, customer_managed_key=None, display_name=None, instance_type=None, ip_access_settings_arn=None, max_concurrent_sessions=None, network_settings_arn=None, tags=None, trust_store_arn=None, user_access_logging_settings_arn=None, user_settings_arn=None)

Bases: object

Properties for defining a CfnPortal.

Parameters:

additional_encryption_context (Union[IResolvable, Mapping[str, str], None]) – The additional encryption context of the portal.
authentication_type (Optional[str]) – 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. 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 Secure Browser console. These cannot be configured in CloudFormation.
browser_settings_arn (Optional[str]) – The ARN of the browser settings that is associated with this web portal.
customer_managed_key (Optional[str]) – 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-]+$
display_name (Optional[str]) – The name of the web portal.
instance_type (Optional[str]) – The type and resources of the underlying instance.
ip_access_settings_arn (Optional[str]) – The ARN of the IP access settings that is associated with the web portal.
max_concurrent_sessions (Union[int, float, None]) – The maximum number of concurrent sessions for the portal.
network_settings_arn (Optional[str]) – The ARN of the network settings that is associated with the web portal.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to add to the web portal. A tag is a key-value pair.
trust_store_arn (Optional[str]) – The ARN of the trust store that is associated with the web portal.
user_access_logging_settings_arn (Optional[str]) – The ARN of the user access logging settings that is associated with the web portal.
user_settings_arn (Optional[str]) – The ARN of the user settings that is associated with the web portal.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesweb as workspacesweb

cfn_portal_props = workspacesweb.CfnPortalProps(
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    authentication_type="authenticationType",
    browser_settings_arn="browserSettingsArn",
    customer_managed_key="customerManagedKey",
    display_name="displayName",
    instance_type="instanceType",
    ip_access_settings_arn="ipAccessSettingsArn",
    max_concurrent_sessions=123,
    network_settings_arn="networkSettingsArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    trust_store_arn="trustStoreArn",
    user_access_logging_settings_arn="userAccessLoggingSettingsArn",
    user_settings_arn="userSettingsArn"
)

Attributes

additional_encryption_context

The additional encryption context of the portal.

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

authentication_type

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:

Create and deploy a CloudFormation template with a Standard portal with no IdentityProvider resource.
Retrieve the SP metadata using Fn:GetAtt , the WorkSpaces Secure Browser console, or by the calling the GetPortalServiceProviderMetadata API.
Submit the data to your IdP.
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 Secure Browser console. These cannot be configured in CloudFormation.