CfnUserSettingsPropsMixin

class aws_cdk.mixins_preview.aws_workspacesweb.mixins.CfnUserSettingsPropsMixin(props, *, strategy=None)

Bases: Mixin

This resource specifies user settings that can be associated with a web portal.

Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html
CloudformationResource:: AWS::WorkSpacesWeb::UserSettings
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_workspacesweb import mixins as workspacesweb_mixins

cfn_user_settings_props_mixin = workspacesweb_mixins.CfnUserSettingsPropsMixin(workspacesweb_mixins.CfnUserSettingsMixinProps(
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    cookie_synchronization_configuration=workspacesweb_mixins.CfnUserSettingsPropsMixin.CookieSynchronizationConfigurationProperty(
        allowlist=[workspacesweb_mixins.CfnUserSettingsPropsMixin.CookieSpecificationProperty(
            domain="domain",
            name="name",
            path="path"
        )],
        blocklist=[workspacesweb_mixins.CfnUserSettingsPropsMixin.CookieSpecificationProperty(
            domain="domain",
            name="name",
            path="path"
        )]
    ),
    copy_allowed="copyAllowed",
    customer_managed_key="customerManagedKey",
    deep_link_allowed="deepLinkAllowed",
    disconnect_timeout_in_minutes=123,
    download_allowed="downloadAllowed",
    idle_disconnect_timeout_in_minutes=123,
    paste_allowed="pasteAllowed",
    print_allowed="printAllowed",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    toolbar_configuration=workspacesweb_mixins.CfnUserSettingsPropsMixin.ToolbarConfigurationProperty(
        hidden_toolbar_items=["hiddenToolbarItems"],
        max_display_resolution="maxDisplayResolution",
        toolbar_type="toolbarType",
        visual_mode="visualMode"
    ),
    upload_allowed="uploadAllowed"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['additionalEncryptionContext', 'cookieSynchronizationConfiguration', 'copyAllowed', 'customerManagedKey', 'deepLinkAllowed', 'disconnectTimeoutInMinutes', 'downloadAllowed', 'idleDisconnectTimeoutInMinutes', 'pasteAllowed', 'printAllowed', 'tags', 'toolbarConfiguration', 'uploadAllowed']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

CookieSpecificationProperty

class CfnUserSettingsPropsMixin.CookieSpecificationProperty(*, domain=None, name=None, path=None)

Bases: object

Specifies a single cookie or set of cookies in an end user’s browser.

Parameters:

domain (Optional[str]) – The domain of the cookie.
name (Optional[str]) – The name of the cookie.
path (Optional[str]) – The path of the cookie.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiespecification.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.mixins_preview.aws_workspacesweb import mixins as workspacesweb_mixins

cookie_specification_property = workspacesweb_mixins.CfnUserSettingsPropsMixin.CookieSpecificationProperty(
    domain="domain",
    name="name",
    path="path"
)

Attributes

domain

The domain of the cookie.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiespecification.html#cfn-workspacesweb-usersettings-cookiespecification-domain

name

The name of the cookie.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiespecification.html#cfn-workspacesweb-usersettings-cookiespecification-name

path

The path of the cookie.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiespecification.html#cfn-workspacesweb-usersettings-cookiespecification-path

CookieSynchronizationConfigurationProperty

class CfnUserSettingsPropsMixin.CookieSynchronizationConfigurationProperty(*, allowlist=None, blocklist=None)

Bases: object

The configuration that specifies which cookies should be synchronized from the end user’s local browser to the remote browser.

Parameters:

allowlist (Union[IResolvable, Sequence[Union[IResolvable, CookieSpecificationProperty, Dict[str, Any]]], None]) – The list of cookie specifications that are allowed to be synchronized to the remote browser.
blocklist (Union[IResolvable, Sequence[Union[IResolvable, CookieSpecificationProperty, Dict[str, Any]]], None]) – The list of cookie specifications that are blocked from being synchronized to the remote browser.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration.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.mixins_preview.aws_workspacesweb import mixins as workspacesweb_mixins

cookie_synchronization_configuration_property = workspacesweb_mixins.CfnUserSettingsPropsMixin.CookieSynchronizationConfigurationProperty(
    allowlist=[workspacesweb_mixins.CfnUserSettingsPropsMixin.CookieSpecificationProperty(
        domain="domain",
        name="name",
        path="path"
    )],
    blocklist=[workspacesweb_mixins.CfnUserSettingsPropsMixin.CookieSpecificationProperty(
        domain="domain",
        name="name",
        path="path"
    )]
)

Attributes

allowlist

The list of cookie specifications that are allowed to be synchronized to the remote browser.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration.html#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-allowlist

blocklist

The list of cookie specifications that are blocked from being synchronized to the remote browser.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-cookiesynchronizationconfiguration.html#cfn-workspacesweb-usersettings-cookiesynchronizationconfiguration-blocklist

ToolbarConfigurationProperty

class CfnUserSettingsPropsMixin.ToolbarConfigurationProperty(*, hidden_toolbar_items=None, max_display_resolution=None, toolbar_type=None, visual_mode=None)

Bases: object

The configuration of the toolbar.

This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

Parameters:

hidden_toolbar_items (Optional[Sequence[str]]) – The list of toolbar items to be hidden.
max_display_resolution (Optional[str]) – The maximum display resolution that is allowed for the session.
toolbar_type (Optional[str]) – The type of toolbar displayed during the session.
visual_mode (Optional[str]) – The visual mode of the toolbar.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-toolbarconfiguration.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.mixins_preview.aws_workspacesweb import mixins as workspacesweb_mixins

toolbar_configuration_property = workspacesweb_mixins.CfnUserSettingsPropsMixin.ToolbarConfigurationProperty(
    hidden_toolbar_items=["hiddenToolbarItems"],
    max_display_resolution="maxDisplayResolution",
    toolbar_type="toolbarType",
    visual_mode="visualMode"
)

Attributes

hidden_toolbar_items

The list of toolbar items to be hidden.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-toolbarconfiguration.html#cfn-workspacesweb-usersettings-toolbarconfiguration-hiddentoolbaritems

max_display_resolution

The maximum display resolution that is allowed for the session.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-toolbarconfiguration.html#cfn-workspacesweb-usersettings-toolbarconfiguration-maxdisplayresolution

toolbar_type

The type of toolbar displayed during the session.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-toolbarconfiguration.html#cfn-workspacesweb-usersettings-toolbarconfiguration-toolbartype

visual_mode

The visual mode of the toolbar.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-toolbarconfiguration.html#cfn-workspacesweb-usersettings-toolbarconfiguration-visualmode