CfnWorkspaceMixinProps

class aws_cdk.mixins_preview.aws_connect.mixins.CfnWorkspaceMixinProps(*, associations=None, description=None, instance_arn=None, media=None, name=None, pages=None, tags=None, theme=None, title=None, visibility=None)

Bases: object

Properties for CfnWorkspacePropsMixin.

Parameters:
  • associations (Optional[Sequence[str]]) – The resource ARNs associated with the workspace.

  • description (Optional[str]) – The description of the workspace.

  • instance_arn (Optional[str]) – The Amazon Resource Name (ARN) of the instance.

  • media (Union[IResolvable, Sequence[Union[IResolvable, MediaItemProperty, Dict[str, Any]]], None]) – The media items for the workspace.

  • name (Optional[str]) – The name of the workspace.

  • pages (Union[IResolvable, Sequence[Union[IResolvable, WorkspacePageProperty, Dict[str, Any]]], None]) – The pages associated with the workspace.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for the workspace.

  • theme (Union[IResolvable, WorkspaceThemeProperty, Dict[str, Any], None]) – The theme configuration for the workspace, including colors and styling.

  • title (Optional[str]) – The title displayed for the workspace.

  • visibility (Optional[str]) – Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html

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.aws_connect import mixins as connect_mixins

cfn_workspace_mixin_props = 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"
)

Attributes

associations

The resource ARNs associated with the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-associations

description

The description of the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-description

instance_arn

The Amazon Resource Name (ARN) of the instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-instancearn

media

The media items for the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-media

name

The name of the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-name

pages

The pages associated with the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-pages

tags

The tags used to organize, track, or control access for the workspace.

See:

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

theme

The theme configuration for the workspace, including colors and styling.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-theme

title

The title displayed for the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-title

visibility

Controls who can access the workspace.

Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-workspace.html#cfn-connect-workspace-visibility