CfnUserSettingsProps

class aws_cdk.aws_workspacesweb.CfnUserSettingsProps(*, copy_allowed, download_allowed, paste_allowed, print_allowed, upload_allowed, additional_encryption_context=None, cookie_synchronization_configuration=None, customer_managed_key=None, deep_link_allowed=None, disconnect_timeout_in_minutes=None, idle_disconnect_timeout_in_minutes=None, tags=None, toolbar_configuration=None)

Bases: object

Properties for defining a CfnUserSettings.

Parameters:

• copy_allowed (str) – Specifies whether the user can copy text from the streaming session to the local device.

• download_allowed (str) – Specifies whether the user can download files from the streaming session to the local device.

• paste_allowed (str) – Specifies whether the user can paste text from the local device to the streaming session.

• print_allowed (str) – Specifies whether the user can print to the local device.

• upload_allowed (str) – Specifies whether the user can upload files from the local device to the streaming session.

• additional_encryption_context (Union[Mapping[str, str], IResolvable, None]) – The additional encryption context of the user settings.

• cookie_synchronization_configuration (Union[IResolvable, CookieSynchronizationConfigurationProperty, Dict[str, Any], None]) – The configuration that specifies which cookies should be synchronized from the end user’s local browser to the remote browser.

• customer_managed_key (Optional[str]) – The customer managed key used to encrypt sensitive information in the user settings.

• deep_link_allowed (Optional[str]) – Specifies whether the user can use deep links that open automatically when connecting to a session.

• disconnect_timeout_in_minutes (Union[int, float, None]) – The amount of time that a streaming session remains active after users disconnect.

• idle_disconnect_timeout_in_minutes (Union[int, float, None]) – The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to add to the user settings resource. A tag is a key-value pair.

• toolbar_configuration (Union[IResolvable, ToolbarConfigurationProperty, Dict[str, Any], None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.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_user_settings_props = workspacesweb.CfnUserSettingsProps(
    copy_allowed="copyAllowed",
    download_allowed="downloadAllowed",
    paste_allowed="pasteAllowed",
    print_allowed="printAllowed",
    upload_allowed="uploadAllowed",

    # the properties below are optional
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    cookie_synchronization_configuration=workspacesweb.CfnUserSettings.CookieSynchronizationConfigurationProperty(
        allowlist=[workspacesweb.CfnUserSettings.CookieSpecificationProperty(
            domain="domain",

            # the properties below are optional
            name="name",
            path="path"
        )],

        # the properties below are optional
        blocklist=[workspacesweb.CfnUserSettings.CookieSpecificationProperty(
            domain="domain",

            # the properties below are optional
            name="name",
            path="path"
        )]
    ),
    customer_managed_key="customerManagedKey",
    deep_link_allowed="deepLinkAllowed",
    disconnect_timeout_in_minutes=123,
    idle_disconnect_timeout_in_minutes=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    toolbar_configuration=workspacesweb.CfnUserSettings.ToolbarConfigurationProperty(
        hidden_toolbar_items=["hiddenToolbarItems"],
        max_display_resolution="maxDisplayResolution",
        toolbar_type="toolbarType",
        visual_mode="visualMode"
    )
)

Attributes

additional_encryption_context

The additional encryption context of the user settings.

See:

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

cookie_synchronization_configuration

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

See:

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

copy_allowed

Specifies whether the user can copy text from the streaming session to the local device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-copyallowed

customer_managed_key

The customer managed key used to encrypt sensitive information in the user settings.

See:

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

deep_link_allowed

Specifies whether the user can use deep links that open automatically when connecting to a session.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-deeplinkallowed

disconnect_timeout_in_minutes

The amount of time that a streaming session remains active after users disconnect.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-disconnecttimeoutinminutes

download_allowed

Specifies whether the user can download files from the streaming session to the local device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-downloadallowed

idle_disconnect_timeout_in_minutes

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-idledisconnecttimeoutinminutes

paste_allowed

Specifies whether the user can paste text from the local device to the streaming session.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-pasteallowed

print_allowed

Specifies whether the user can print to the local device.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-printallowed

tags

The tags to add to the user settings resource.

A tag is a key-value pair.

See:

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

toolbar_configuration

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.

See:

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

upload_allowed

Specifies whether the user can upload files from the local device to the streaming session.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspacesweb-usersettings.html#cfn-workspacesweb-usersettings-uploadallowed