CfnUserSettingsPropsMixin
- class aws_cdk.mixins_preview.aws_workspacesweb.mixins.CfnUserSettingsPropsMixin(props, *, strategy=None)
Bases:
MixinThis 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:
- CloudformationResource:
AWS::WorkSpacesWeb::UserSettings
- Mixin:
true
- 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.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" }, branding_configuration=workspacesweb_mixins.CfnUserSettingsPropsMixin.BrandingConfigurationProperty( color_theme="colorTheme", favicon="favicon", favicon_metadata=workspacesweb_mixins.CfnUserSettingsPropsMixin.ImageMetadataProperty( file_extension="fileExtension", last_upload_timestamp="lastUploadTimestamp", mime_type="mimeType" ), localized_strings={ "localized_strings_key": workspacesweb_mixins.CfnUserSettingsPropsMixin.LocalizedBrandingStringsProperty( browser_tab_title="browserTabTitle", contact_button_text="contactButtonText", contact_link="contactLink", loading_text="loadingText", login_button_text="loginButtonText", login_description="loginDescription", login_title="loginTitle", welcome_text="welcomeText" ) }, logo="logo", logo_metadata=workspacesweb_mixins.CfnUserSettingsPropsMixin.ImageMetadataProperty( file_extension="fileExtension", last_upload_timestamp="lastUploadTimestamp", mime_type="mimeType" ), terms_of_service="termsOfService", wallpaper="wallpaper", wallpaper_metadata=workspacesweb_mixins.CfnUserSettingsPropsMixin.ImageMetadataProperty( file_extension="fileExtension", last_upload_timestamp="lastUploadTimestamp", mime_type="mimeType" ) ), 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", web_authn_allowed="webAuthnAllowed" ), 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:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['additionalEncryptionContext', 'brandingConfiguration', 'cookieSynchronizationConfiguration', 'copyAllowed', 'customerManagedKey', 'deepLinkAllowed', 'disconnectTimeoutInMinutes', 'downloadAllowed', 'idleDisconnectTimeoutInMinutes', 'pasteAllowed', 'printAllowed', 'tags', 'toolbarConfiguration', 'uploadAllowed', 'webAuthnAllowed']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
BrandingConfigurationProperty
- class CfnUserSettingsPropsMixin.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:
objectThe 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. ChooseLightif you upload a dark wallpaper, orDarkfor 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 theFn::GetAttintrinsic 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 theFn::GetAttintrinsic 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 theFn::GetAttintrinsic function.
- See:
- 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 branding_configuration_property = workspacesweb_mixins.CfnUserSettingsPropsMixin.BrandingConfigurationProperty( color_theme="colorTheme", favicon="favicon", favicon_metadata=workspacesweb_mixins.CfnUserSettingsPropsMixin.ImageMetadataProperty( file_extension="fileExtension", last_upload_timestamp="lastUploadTimestamp", mime_type="mimeType" ), localized_strings={ "localized_strings_key": workspacesweb_mixins.CfnUserSettingsPropsMixin.LocalizedBrandingStringsProperty( browser_tab_title="browserTabTitle", contact_button_text="contactButtonText", contact_link="contactLink", loading_text="loadingText", login_button_text="loginButtonText", login_description="loginDescription", login_title="loginTitle", welcome_text="welcomeText" ) }, logo="logo", logo_metadata=workspacesweb_mixins.CfnUserSettingsPropsMixin.ImageMetadataProperty( file_extension="fileExtension", last_upload_timestamp="lastUploadTimestamp", mime_type="mimeType" ), terms_of_service="termsOfService", wallpaper="wallpaper", wallpaper_metadata=workspacesweb_mixins.CfnUserSettingsPropsMixin.ImageMetadataProperty( file_extension="fileExtension", last_upload_timestamp="lastUploadTimestamp", mime_type="mimeType" ) )
Attributes
- color_theme
The color theme for components on the web portal.
Choose
Lightif you upload a dark wallpaper, orDarkfor a light wallpaper.
- 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.
- 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::GetAttintrinsic function.
- localized_strings
A map of localized text strings for different languages, allowing the portal to display content in the user’s preferred language.
- logo
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
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::GetAttintrinsic function.
- terms_of_service
The terms of service text in Markdown format that users must accept before accessing the portal.
- 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.
- 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::GetAttintrinsic function.
ImageMetadataProperty
- class CfnUserSettingsPropsMixin.ImageMetadataProperty(*, file_extension=None, last_upload_timestamp=None, mime_type=None)
Bases:
objectMetadata information about an uploaded image file.
- Parameters:
file_extension (
Optional[str]) – The file extension of the image.last_upload_timestamp (
Optional[str]) – The timestamp when the image was last uploaded.mime_type (
Optional[str]) – The MIME type of the image.
- See:
- 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 image_metadata_property = workspacesweb_mixins.CfnUserSettingsPropsMixin.ImageMetadataProperty( file_extension="fileExtension", last_upload_timestamp="lastUploadTimestamp", mime_type="mimeType" )
Attributes
- file_extension
The file extension of the image.
- last_upload_timestamp
The timestamp when the image was last uploaded.
LocalizedBrandingStringsProperty
- class CfnUserSettingsPropsMixin.LocalizedBrandingStringsProperty(*, browser_tab_title=None, contact_button_text=None, contact_link=None, loading_text=None, login_button_text=None, login_description=None, login_title=None, welcome_text=None)
Bases:
objectLocalized text strings for a specific language that customize the web portal.
- Parameters:
browser_tab_title (
Optional[str]) – The text displayed in the browser tab title.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 withhttps://ormailto:. 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”.welcome_text (
Optional[str]) – The welcome text displayed on the sign-in page.
- See:
- 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 localized_branding_strings_property = workspacesweb_mixins.CfnUserSettingsPropsMixin.LocalizedBrandingStringsProperty( browser_tab_title="browserTabTitle", contact_button_text="contactButtonText", contact_link="contactLink", loading_text="loadingText", login_button_text="loginButtonText", login_description="loginDescription", login_title="loginTitle", welcome_text="welcomeText" )
Attributes
- browser_tab_title
The text displayed in the browser tab title.
- contact_button_text
The text displayed on the contact button.
This field is optional and defaults to “Contact us”.
- contact_link
A contact link URL.
The URL must start with
https://ormailto:. If not provided, the contact button will be hidden from the web portal screen.
- loading_text
The text displayed during session loading.
This field is optional and defaults to “Loading your session”.
- login_button_text
The text displayed on the login button.
This field is optional and defaults to “Sign In”.
- login_description
The description text for the login section.
This field is optional and defaults to “Sign in to your session”.
- login_title
The title text for the login section.
This field is optional and defaults to “Sign In”.
- welcome_text
The welcome text displayed on the sign-in page.
ToolbarConfigurationProperty
- class CfnUserSettingsPropsMixin.ToolbarConfigurationProperty(*, hidden_toolbar_items=None, max_display_resolution=None, toolbar_type=None, visual_mode=None)
Bases:
objectThe 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:
- 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
The list of toolbar items to be hidden.
- max_display_resolution
The maximum display resolution that is allowed for the session.
- toolbar_type
The type of toolbar displayed during the session.
- visual_mode
The visual mode of the toolbar.