CfnUserSettings

class aws_cdk.aws_workspacesweb.CfnUserSettings(scope, id, *, copy_allowed, download_allowed, paste_allowed, print_allowed, upload_allowed, additional_encryption_context=None, branding_configuration=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, web_authn_allowed=None)

Bases: CfnResource

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# 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 = workspacesweb.CfnUserSettings(self, "MyCfnUserSettings",
    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"
    },
    branding_configuration=workspacesweb.CfnUserSettings.BrandingConfigurationProperty(
        color_theme="colorTheme",
        favicon="favicon",
        favicon_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
            file_extension="fileExtension",
            last_upload_timestamp="lastUploadTimestamp",
            mime_type="mimeType"
        ),
        localized_strings={
            "localized_strings_key": workspacesweb.CfnUserSettings.LocalizedBrandingStringsProperty(
                browser_tab_title="browserTabTitle",
                welcome_text="welcomeText",

                # the properties below are optional
                contact_button_text="contactButtonText",
                contact_link="contactLink",
                loading_text="loadingText",
                login_button_text="loginButtonText",
                login_description="loginDescription",
                login_title="loginTitle"
            )
        },
        logo="logo",
        logo_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
            file_extension="fileExtension",
            last_upload_timestamp="lastUploadTimestamp",
            mime_type="mimeType"
        ),
        terms_of_service="termsOfService",
        wallpaper="wallpaper",
        wallpaper_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
            file_extension="fileExtension",
            last_upload_timestamp="lastUploadTimestamp",
            mime_type="mimeType"
        )
    ),
    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"
    ),
    web_authn_allowed="webAuthnAllowed"
)

Create a new AWS::WorkSpacesWeb::UserSettings.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • 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.

  • branding_configuration (Union[IResolvable, BrandingConfigurationProperty, Dict[str, Any], None]) – The branding configuration that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, wallpaper, localized strings, color theme, and an optional terms of service.

  • 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.

  • web_authn_allowed (Optional[str]) – Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::WorkSpacesWeb::UserSettings'
additional_encryption_context

The additional encryption context of the user settings.

attr_associated_portal_arns

A list of web portal ARNs that this user settings resource is associated with.

CloudformationAttribute:

AssociatedPortalArns

attr_branding_configuration_favicon_metadata

Read-only.

Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

CloudformationAttribute:

BrandingConfiguration.FaviconMetadata

attr_branding_configuration_logo_metadata

Read-only.

Metadata for the logo image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

CloudformationAttribute:

BrandingConfiguration.LogoMetadata

attr_branding_configuration_wallpaper_metadata

Read-only.

Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

CloudformationAttribute:

BrandingConfiguration.WallpaperMetadata

attr_user_settings_arn

The ARN of the user settings.

CloudformationAttribute:

UserSettingsArn

branding_configuration

The branding configuration that customizes the appearance of the web portal for end users.

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

cookie_synchronization_configuration

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

copy_allowed

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

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

customer_managed_key

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

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

disconnect_timeout_in_minutes

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

download_allowed

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

env
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.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

paste_allowed

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

print_allowed

Specifies whether the user can print to the local device.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

The tags to add to the user settings resource.

toolbar_configuration

The configuration of the toolbar.

upload_allowed

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

user_settings_ref

A reference to a UserSettings resource.

web_authn_allowed

Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Static Methods

classmethod arn_for_user_settings(resource)
Parameters:

resource (IUserSettingsRef)

Return type:

str

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_user_settings(x)

Checks whether the given object is a CfnUserSettings.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

BrandingConfigurationProperty

class CfnUserSettings.BrandingConfigurationProperty(*, color_theme=None, favicon=None, favicon_metadata=None, localized_strings=None, logo=None, logo_metadata=None, terms_of_service=None, wallpaper=None, wallpaper_metadata=None)

Bases: object

The branding configuration that customizes the appearance of the web portal for end users.

This includes a custom logo, favicon, wallpaper, localized strings, color theme, and an optional terms of service. .. epigraph:

The ``LogoMetadata`` , ``FaviconMetadata`` , and ``WallpaperMetadata`` properties are read-only and cannot be specified in your template. They are automatically populated by the service after you upload images and can be retrieved using the ``Fn::GetAtt`` intrinsic function.
Parameters:

  • color_theme (Optional[str]) – The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.

  • favicon (Optional[str]) – The favicon image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

  • favicon_metadata (Union[IResolvable, ImageMetadataProperty, Dict[str, Any], None]) – Read-only. Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

  • localized_strings (Union[IResolvable, Mapping[str, Union[IResolvable, LocalizedBrandingStringsProperty, Dict[str, Any]]], None]) – A map of localized text strings for different languages, allowing the portal to display content in the user’s preferred language.

  • logo (Optional[str]) – The logo image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

  • logo_metadata (Union[IResolvable, ImageMetadataProperty, Dict[str, Any], None]) – Read-only. Metadata for the logo image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

  • terms_of_service (Optional[str]) – The terms of service text in Markdown format that users must accept before accessing the portal.

  • wallpaper (Optional[str]) – The wallpaper image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.

  • wallpaper_metadata (Union[IResolvable, ImageMetadataProperty, Dict[str, Any], None]) – Read-only. Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.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

branding_configuration_property = workspacesweb.CfnUserSettings.BrandingConfigurationProperty(
    color_theme="colorTheme",
    favicon="favicon",
    favicon_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
        file_extension="fileExtension",
        last_upload_timestamp="lastUploadTimestamp",
        mime_type="mimeType"
    ),
    localized_strings={
        "localized_strings_key": workspacesweb.CfnUserSettings.LocalizedBrandingStringsProperty(
            browser_tab_title="browserTabTitle",
            welcome_text="welcomeText",

            # the properties below are optional
            contact_button_text="contactButtonText",
            contact_link="contactLink",
            loading_text="loadingText",
            login_button_text="loginButtonText",
            login_description="loginDescription",
            login_title="loginTitle"
        )
    },
    logo="logo",
    logo_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
        file_extension="fileExtension",
        last_upload_timestamp="lastUploadTimestamp",
        mime_type="mimeType"
    ),
    terms_of_service="termsOfService",
    wallpaper="wallpaper",
    wallpaper_metadata=workspacesweb.CfnUserSettings.ImageMetadataProperty(
        file_extension="fileExtension",
        last_upload_timestamp="lastUploadTimestamp",
        mime_type="mimeType"
    )
)

Attributes

color_theme

The color theme for components on the web portal.

Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-colortheme

favicon

The favicon image for the portal.

Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-favicon

favicon_metadata

Read-only.

Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-faviconmetadata

localized_strings

A map of localized text strings for different languages, allowing the portal to display content in the user’s preferred language.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-localizedstrings

The logo image for the portal.

Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-logo

logo_metadata

Read-only.

Metadata for the logo image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-logometadata

terms_of_service

The terms of service text in Markdown format that users must accept before accessing the portal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-termsofservice

wallpaper

The wallpaper image for the portal.

Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-wallpaper

wallpaper_metadata

Read-only.

Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-brandingconfiguration.html#cfn-workspacesweb-usersettings-brandingconfiguration-wallpapermetadata

CookieSpecificationProperty

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

Bases: object

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

Parameters:

  • domain (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 import aws_workspacesweb as workspacesweb

cookie_specification_property = workspacesweb.CfnUserSettings.CookieSpecificationProperty(
    domain="domain",

    # the properties below are optional
    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 CfnUserSettings.CookieSynchronizationConfigurationProperty(*, allowlist, 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:
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 import aws_workspacesweb as workspacesweb

cookie_synchronization_configuration_property = 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"
    )]
)

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

ImageMetadataProperty

class CfnUserSettings.ImageMetadataProperty(*, file_extension, last_upload_timestamp, mime_type)

Bases: object

Metadata information about an uploaded image file.

Parameters:

  • file_extension (str) – The file extension of the image.

  • last_upload_timestamp (str) – The timestamp when the image was last uploaded.

  • mime_type (str) – The MIME type of the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-imagemetadata.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

image_metadata_property = workspacesweb.CfnUserSettings.ImageMetadataProperty(
    file_extension="fileExtension",
    last_upload_timestamp="lastUploadTimestamp",
    mime_type="mimeType"
)

Attributes

file_extension

The file extension of the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-imagemetadata.html#cfn-workspacesweb-usersettings-imagemetadata-fileextension

last_upload_timestamp

The timestamp when the image was last uploaded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-imagemetadata.html#cfn-workspacesweb-usersettings-imagemetadata-lastuploadtimestamp

mime_type

The MIME type of the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-imagemetadata.html#cfn-workspacesweb-usersettings-imagemetadata-mimetype

LocalizedBrandingStringsProperty

class CfnUserSettings.LocalizedBrandingStringsProperty(*, browser_tab_title, welcome_text, contact_button_text=None, contact_link=None, loading_text=None, login_button_text=None, login_description=None, login_title=None)

Bases: object

Localized text strings for a specific language that customize the web portal.

Parameters:

  • browser_tab_title (str) – The text displayed in the browser tab title.

  • welcome_text (str) – The welcome text displayed on the sign-in page.

  • contact_button_text (Optional[str]) – The text displayed on the contact button. This field is optional and defaults to “Contact us”.

  • contact_link (Optional[str]) – A contact link URL. The URL must start with https:// or mailto: . If not provided, the contact button will be hidden from the web portal screen.

  • loading_text (Optional[str]) – The text displayed during session loading. This field is optional and defaults to “Loading your session”.

  • login_button_text (Optional[str]) – The text displayed on the login button. This field is optional and defaults to “Sign In”.

  • login_description (Optional[str]) – The description text for the login section. This field is optional and defaults to “Sign in to your session”.

  • login_title (Optional[str]) – The title text for the login section. This field is optional and defaults to “Sign In”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.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

localized_branding_strings_property = workspacesweb.CfnUserSettings.LocalizedBrandingStringsProperty(
    browser_tab_title="browserTabTitle",
    welcome_text="welcomeText",

    # the properties below are optional
    contact_button_text="contactButtonText",
    contact_link="contactLink",
    loading_text="loadingText",
    login_button_text="loginButtonText",
    login_description="loginDescription",
    login_title="loginTitle"
)

Attributes

browser_tab_title

The text displayed in the browser tab title.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-browsertabtitle

contact_button_text

The text displayed on the contact button.

This field is optional and defaults to “Contact us”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-contactbuttontext

A contact link URL.

The URL must start with https:// or mailto: . If not provided, the contact button will be hidden from the web portal screen.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-contactlink

loading_text

The text displayed during session loading.

This field is optional and defaults to “Loading your session”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-loadingtext

login_button_text

The text displayed on the login button.

This field is optional and defaults to “Sign In”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-loginbuttontext

login_description

The description text for the login section.

This field is optional and defaults to “Sign in to your session”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-logindescription

login_title

The title text for the login section.

This field is optional and defaults to “Sign In”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-logintitle

welcome_text

The welcome text displayed on the sign-in page.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-welcometext

ToolbarConfigurationProperty

class CfnUserSettings.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 import aws_workspacesweb as workspacesweb

toolbar_configuration_property = workspacesweb.CfnUserSettings.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