CfnWorkspacePropsMixin
- class aws_cdk.mixins_preview.aws_connect.mixins.CfnWorkspacePropsMixin(props, *, strategy=None)
Bases:
MixinContains information about a workspace, which defines the user experience by mapping views to pages.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html
- CloudformationResource:
AWS::Connect::Workspace
- 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_connect import mixins as connect_mixins cfn_workspace_props_mixin = connect_mixins.CfnWorkspacePropsMixin(connect_mixins.CfnWorkspaceMixinProps( associations=["associations"], description="description", instance_arn="instanceArn", media=[connect_mixins.CfnWorkspacePropsMixin.MediaItemProperty( source="source", type="type" )], name="name", pages=[connect_mixins.CfnWorkspacePropsMixin.WorkspacePageProperty( input_data="inputData", page="page", resource_arn="resourceArn", slug="slug" )], tags=[CfnTag( key="key", value="value" )], theme=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeProperty( dark=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeConfigProperty( palette=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemePaletteProperty( canvas=connect_mixins.CfnWorkspacePropsMixin.PaletteCanvasProperty( active_background="activeBackground", container_background="containerBackground", page_background="pageBackground" ), header=connect_mixins.CfnWorkspacePropsMixin.PaletteHeaderProperty( background="background", invert_actions_colors=False, text="text", text_hover="textHover" ), navigation=connect_mixins.CfnWorkspacePropsMixin.PaletteNavigationProperty( background="background", invert_actions_colors=False, text="text", text_active="textActive", text_background_active="textBackgroundActive", text_background_hover="textBackgroundHover", text_hover="textHover" ), primary=connect_mixins.CfnWorkspacePropsMixin.PalettePrimaryProperty( active="active", contrast_text="contrastText", default="default" ) ), typography=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeTypographyProperty( font_family=connect_mixins.CfnWorkspacePropsMixin.FontFamilyProperty( default="default" ) ) ), light=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeConfigProperty( palette=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemePaletteProperty( canvas=connect_mixins.CfnWorkspacePropsMixin.PaletteCanvasProperty( active_background="activeBackground", container_background="containerBackground", page_background="pageBackground" ), header=connect_mixins.CfnWorkspacePropsMixin.PaletteHeaderProperty( background="background", invert_actions_colors=False, text="text", text_hover="textHover" ), navigation=connect_mixins.CfnWorkspacePropsMixin.PaletteNavigationProperty( background="background", invert_actions_colors=False, text="text", text_active="textActive", text_background_active="textBackgroundActive", text_background_hover="textBackgroundHover", text_hover="textHover" ), primary=connect_mixins.CfnWorkspacePropsMixin.PalettePrimaryProperty( active="active", contrast_text="contrastText", default="default" ) ), typography=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeTypographyProperty( font_family=connect_mixins.CfnWorkspacePropsMixin.FontFamilyProperty( default="default" ) ) ) ), title="title", visibility="visibility" ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::Connect::Workspace.- Parameters:
props (
Union[CfnWorkspaceMixinProps,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:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['associations', 'description', 'instanceArn', 'media', 'name', 'pages', 'tags', 'theme', 'title', 'visibility']
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
FontFamilyProperty
- class CfnWorkspacePropsMixin.FontFamilyProperty(*, default=None)
Bases:
objectContains font family configuration for workspace themes.
- Parameters:
default (
Optional[str]) – The default font family to use in the workspace theme.- 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_connect import mixins as connect_mixins font_family_property = connect_mixins.CfnWorkspacePropsMixin.FontFamilyProperty( default="default" )
Attributes
- default
The default font family to use in the workspace theme.
MediaItemProperty
- class CfnWorkspacePropsMixin.MediaItemProperty(*, source=None, type=None)
Bases:
objectContains information about a media asset used in a workspace.
- Parameters:
source (
Optional[str]) – The source URL or data for the media asset.type (
Optional[str]) – The type of media. Valid values are:IMAGE_LOGO_FAVICONandIMAGE_LOGO_HORIZONTAL.
- 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_connect import mixins as connect_mixins media_item_property = connect_mixins.CfnWorkspacePropsMixin.MediaItemProperty( source="source", type="type" )
Attributes
- source
The source URL or data for the media asset.
- type
The type of media.
Valid values are:
IMAGE_LOGO_FAVICONandIMAGE_LOGO_HORIZONTAL.
PaletteCanvasProperty
- class CfnWorkspacePropsMixin.PaletteCanvasProperty(*, active_background=None, container_background=None, page_background=None)
Bases:
objectContains color configuration for canvas elements in a workspace theme.
- Parameters:
active_background (
Optional[str]) – The background color for active elements.container_background (
Optional[str]) – The background color for container elements.page_background (
Optional[str]) – The background color for page elements.
- 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_connect import mixins as connect_mixins palette_canvas_property = connect_mixins.CfnWorkspacePropsMixin.PaletteCanvasProperty( active_background="activeBackground", container_background="containerBackground", page_background="pageBackground" )
Attributes
- active_background
The background color for active elements.
- container_background
The background color for container elements.
- page_background
The background color for page elements.
PaletteHeaderProperty
- class CfnWorkspacePropsMixin.PaletteHeaderProperty(*, background=None, invert_actions_colors=None, text=None, text_hover=None)
Bases:
objectContains color configuration for header elements in a workspace theme.
- Parameters:
background (
Optional[str]) – The background color of the header.invert_actions_colors (
Union[bool,IResolvable,None]) – Whether to invert the colors of action buttons in the header.text (
Optional[str]) – The text color in the header.text_hover (
Optional[str]) – The text color when hovering over header elements.
- 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_connect import mixins as connect_mixins palette_header_property = connect_mixins.CfnWorkspacePropsMixin.PaletteHeaderProperty( background="background", invert_actions_colors=False, text="text", text_hover="textHover" )
Attributes
- background
The background color of the header.
- invert_actions_colors
Whether to invert the colors of action buttons in the header.
- text
The text color in the header.
- text_hover
The text color when hovering over header elements.
PalettePrimaryProperty
- class CfnWorkspacePropsMixin.PalettePrimaryProperty(*, active=None, contrast_text=None, default=None)
Bases:
objectContains primary color configuration for a workspace theme.
- Parameters:
active (
Optional[str]) – The primary color used for active states.contrast_text (
Optional[str]) – The text color that contrasts with the primary color for readability.default (
Optional[str]) – The default primary color used throughout the workspace.
- 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_connect import mixins as connect_mixins palette_primary_property = connect_mixins.CfnWorkspacePropsMixin.PalettePrimaryProperty( active="active", contrast_text="contrastText", default="default" )
Attributes
- active
The primary color used for active states.
- contrast_text
The text color that contrasts with the primary color for readability.
- default
The default primary color used throughout the workspace.
WorkspacePageProperty
- class CfnWorkspacePropsMixin.WorkspacePageProperty(*, input_data=None, page=None, resource_arn=None, slug=None)
Bases:
objectContains information about a page configuration in a workspace, including the view assigned to the page.
- Parameters:
input_data (
Optional[str]) – A JSON string containing input parameters passed to the view when the page is rendered.page (
Optional[str]) – The page identifier. System pages includeHOMEandAGENT_EXPERIENCE.resource_arn (
Optional[str]) – The Amazon Resource Name (ARN) of the view associated with this page.slug (
Optional[str]) – The URL-friendly identifier for the 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_connect import mixins as connect_mixins workspace_page_property = connect_mixins.CfnWorkspacePropsMixin.WorkspacePageProperty( input_data="inputData", page="page", resource_arn="resourceArn", slug="slug" )
Attributes
- input_data
A JSON string containing input parameters passed to the view when the page is rendered.
- page
The page identifier.
System pages include
HOMEandAGENT_EXPERIENCE.
- resource_arn
The Amazon Resource Name (ARN) of the view associated with this page.
- slug
The URL-friendly identifier for the page.
WorkspaceThemeConfigProperty
- class CfnWorkspacePropsMixin.WorkspaceThemeConfigProperty(*, palette=None, typography=None)
Bases:
objectContains detailed theme configuration for a workspace, including colors, images, and typography.
- Parameters:
palette (
Union[IResolvable,WorkspaceThemePaletteProperty,Dict[str,Any],None]) – The color palette configuration for the workspace theme.typography (
Union[IResolvable,WorkspaceThemeTypographyProperty,Dict[str,Any],None]) – The typography configuration for the workspace theme.
- 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_connect import mixins as connect_mixins workspace_theme_config_property = connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeConfigProperty( palette=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemePaletteProperty( canvas=connect_mixins.CfnWorkspacePropsMixin.PaletteCanvasProperty( active_background="activeBackground", container_background="containerBackground", page_background="pageBackground" ), header=connect_mixins.CfnWorkspacePropsMixin.PaletteHeaderProperty( background="background", invert_actions_colors=False, text="text", text_hover="textHover" ), navigation=connect_mixins.CfnWorkspacePropsMixin.PaletteNavigationProperty( background="background", invert_actions_colors=False, text="text", text_active="textActive", text_background_active="textBackgroundActive", text_background_hover="textBackgroundHover", text_hover="textHover" ), primary=connect_mixins.CfnWorkspacePropsMixin.PalettePrimaryProperty( active="active", contrast_text="contrastText", default="default" ) ), typography=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeTypographyProperty( font_family=connect_mixins.CfnWorkspacePropsMixin.FontFamilyProperty( default="default" ) ) )
Attributes
- palette
The color palette configuration for the workspace theme.
- typography
The typography configuration for the workspace theme.
WorkspaceThemePaletteProperty
- class CfnWorkspacePropsMixin.WorkspaceThemePaletteProperty(*, canvas=None, header=None, navigation=None, primary=None)
Bases:
objectContains color palette configuration for different areas of a workspace.
- Parameters:
canvas (
Union[IResolvable,PaletteCanvasProperty,Dict[str,Any],None]) – The color configuration for the canvas area.header (
Union[IResolvable,PaletteHeaderProperty,Dict[str,Any],None]) – The color configuration for the header area.navigation (
Union[IResolvable,PaletteNavigationProperty,Dict[str,Any],None]) – The color configuration for the navigation area.primary (
Union[IResolvable,PalettePrimaryProperty,Dict[str,Any],None]) – The primary color configuration used throughout the workspace.
- 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_connect import mixins as connect_mixins workspace_theme_palette_property = connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemePaletteProperty( canvas=connect_mixins.CfnWorkspacePropsMixin.PaletteCanvasProperty( active_background="activeBackground", container_background="containerBackground", page_background="pageBackground" ), header=connect_mixins.CfnWorkspacePropsMixin.PaletteHeaderProperty( background="background", invert_actions_colors=False, text="text", text_hover="textHover" ), navigation=connect_mixins.CfnWorkspacePropsMixin.PaletteNavigationProperty( background="background", invert_actions_colors=False, text="text", text_active="textActive", text_background_active="textBackgroundActive", text_background_hover="textBackgroundHover", text_hover="textHover" ), primary=connect_mixins.CfnWorkspacePropsMixin.PalettePrimaryProperty( active="active", contrast_text="contrastText", default="default" ) )
Attributes
- canvas
The color configuration for the canvas area.
- header
The color configuration for the header area.
The color configuration for the navigation area.
- primary
The primary color configuration used throughout the workspace.
WorkspaceThemeProperty
- class CfnWorkspacePropsMixin.WorkspaceThemeProperty(*, dark=None, light=None)
Bases:
objectContains theme configuration for a workspace, supporting both light and dark modes.
- Parameters:
dark (
Union[IResolvable,WorkspaceThemeConfigProperty,Dict[str,Any],None]) – The theme configuration for dark mode.light (
Union[IResolvable,WorkspaceThemeConfigProperty,Dict[str,Any],None]) – The theme configuration for light mode.
- 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_connect import mixins as connect_mixins workspace_theme_property = connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeProperty( dark=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeConfigProperty( palette=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemePaletteProperty( canvas=connect_mixins.CfnWorkspacePropsMixin.PaletteCanvasProperty( active_background="activeBackground", container_background="containerBackground", page_background="pageBackground" ), header=connect_mixins.CfnWorkspacePropsMixin.PaletteHeaderProperty( background="background", invert_actions_colors=False, text="text", text_hover="textHover" ), navigation=connect_mixins.CfnWorkspacePropsMixin.PaletteNavigationProperty( background="background", invert_actions_colors=False, text="text", text_active="textActive", text_background_active="textBackgroundActive", text_background_hover="textBackgroundHover", text_hover="textHover" ), primary=connect_mixins.CfnWorkspacePropsMixin.PalettePrimaryProperty( active="active", contrast_text="contrastText", default="default" ) ), typography=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeTypographyProperty( font_family=connect_mixins.CfnWorkspacePropsMixin.FontFamilyProperty( default="default" ) ) ), light=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeConfigProperty( palette=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemePaletteProperty( canvas=connect_mixins.CfnWorkspacePropsMixin.PaletteCanvasProperty( active_background="activeBackground", container_background="containerBackground", page_background="pageBackground" ), header=connect_mixins.CfnWorkspacePropsMixin.PaletteHeaderProperty( background="background", invert_actions_colors=False, text="text", text_hover="textHover" ), navigation=connect_mixins.CfnWorkspacePropsMixin.PaletteNavigationProperty( background="background", invert_actions_colors=False, text="text", text_active="textActive", text_background_active="textBackgroundActive", text_background_hover="textBackgroundHover", text_hover="textHover" ), primary=connect_mixins.CfnWorkspacePropsMixin.PalettePrimaryProperty( active="active", contrast_text="contrastText", default="default" ) ), typography=connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeTypographyProperty( font_family=connect_mixins.CfnWorkspacePropsMixin.FontFamilyProperty( default="default" ) ) ) )
Attributes
- dark
The theme configuration for dark mode.
- light
The theme configuration for light mode.
WorkspaceThemeTypographyProperty
- class CfnWorkspacePropsMixin.WorkspaceThemeTypographyProperty(*, font_family=None)
Bases:
objectContains typography configuration for a workspace theme.
- Parameters:
font_family (
Union[IResolvable,FontFamilyProperty,Dict[str,Any],None]) – The font family configuration for text in the workspace.- 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_connect import mixins as connect_mixins workspace_theme_typography_property = connect_mixins.CfnWorkspacePropsMixin.WorkspaceThemeTypographyProperty( font_family=connect_mixins.CfnWorkspacePropsMixin.FontFamilyProperty( default="default" ) )
Attributes
- font_family
The font family configuration for text in the workspace.