CfnPortalPropsMixin

class aws_cdk.cfn_property_mixins.aws_workspacesweb.CfnPortalPropsMixin(props, *, strategy=None)

Bases: Mixin

This resource specifies a web portal, which users use to start browsing sessions.

A Standard web portal can’t start browsing sessions unless you have at defined and associated an IdentityProvider and NetworkSettings resource. An IAM Identity Center web portal does not require an IdentityProvider resource.

For more information about web portals, see What is Amazon WorkSpaces Secure Browser? .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-portal.html
CloudformationResource:: AWS::WorkSpacesWeb::Portal
Mixin:: true
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.cfn_property_mixins import aws_workspacesweb as workspacesweb
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_portal_props_mixin = workspacesweb.CfnPortalPropsMixin(workspacesweb.CfnPortalMixinProps(
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    authentication_type="authenticationType",
    browser_settings_arn="browserSettingsArn",
    customer_managed_key="customerManagedKey",
    data_protection_settings_arn="dataProtectionSettingsArn",
    display_name="displayName",
    instance_type="instanceType",
    ip_access_settings_arn="ipAccessSettingsArn",
    max_concurrent_sessions=123,
    network_settings_arn="networkSettingsArn",
    portal_custom_domain="portalCustomDomain",
    session_logger_arn="sessionLoggerArn",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    trust_store_arn="trustStoreArn",
    user_access_logging_settings_arn="userAccessLoggingSettingsArn",
    user_settings_arn="userSettingsArn"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::WorkSpacesWeb::Portal.

Parameters:

props (Union[CfnPortalMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['additionalEncryptionContext', 'authenticationType', 'browserSettingsArn', 'customerManagedKey', 'dataProtectionSettingsArn', 'displayName', 'instanceType', 'ipAccessSettingsArn', 'maxConcurrentSessions', 'networkSettingsArn', 'portalCustomDomain', 'sessionLoggerArn', 'tags', 'trustStoreArn', 'userAccessLoggingSettingsArn', 'userSettingsArn']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.