CfnWorkspaceProps

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

Bases: object

Properties for defining a CfnWorkspace.

Parameters:

instance_arn (str) – The Amazon Resource Name (ARN) of the instance.
name (str) – The name of the workspace.
associations (Optional[Sequence[str]]) – The resource ARNs associated with the workspace.
description (Optional[str]) – The description of the workspace.
media (Union[IResolvable, Sequence[Union[IResolvable, MediaItemProperty, Dict[str, Any]]], None]) – The media items for 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 import aws_connect as connect

cfn_workspace_props = connect.CfnWorkspaceProps(
    instance_arn="instanceArn",
    name="name",

    # the properties below are optional
    associations=["associations"],
    description="description",
    media=[connect.CfnWorkspace.MediaItemProperty(
        type="type",

        # the properties below are optional
        source="source"
    )],
    pages=[connect.CfnWorkspace.WorkspacePageProperty(
        page="page",
        resource_arn="resourceArn",

        # the properties below are optional
        input_data="inputData",
        slug="slug"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    theme=connect.CfnWorkspace.WorkspaceThemeProperty(
        dark=connect.CfnWorkspace.WorkspaceThemeConfigProperty(
            palette=connect.CfnWorkspace.WorkspaceThemePaletteProperty(
                canvas=connect.CfnWorkspace.PaletteCanvasProperty(
                    active_background="activeBackground",
                    container_background="containerBackground",
                    page_background="pageBackground"
                ),
                header=connect.CfnWorkspace.PaletteHeaderProperty(
                    background="background",
                    invert_actions_colors=False,
                    text="text",
                    text_hover="textHover"
                ),
                navigation=connect.CfnWorkspace.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.CfnWorkspace.PalettePrimaryProperty(
                    active="active",
                    contrast_text="contrastText",
                    default="default"
                )
            ),
            typography=connect.CfnWorkspace.WorkspaceThemeTypographyProperty(
                font_family=connect.CfnWorkspace.FontFamilyProperty(
                    default="default"
                )
            )
        ),
        light=connect.CfnWorkspace.WorkspaceThemeConfigProperty(
            palette=connect.CfnWorkspace.WorkspaceThemePaletteProperty(
                canvas=connect.CfnWorkspace.PaletteCanvasProperty(
                    active_background="activeBackground",
                    container_background="containerBackground",
                    page_background="pageBackground"
                ),
                header=connect.CfnWorkspace.PaletteHeaderProperty(
                    background="background",
                    invert_actions_colors=False,
                    text="text",
                    text_hover="textHover"
                ),
                navigation=connect.CfnWorkspace.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.CfnWorkspace.PalettePrimaryProperty(
                    active="active",
                    contrast_text="contrastText",
                    default="default"
                )
            ),
            typography=connect.CfnWorkspace.WorkspaceThemeTypographyProperty(
                font_family=connect.CfnWorkspace.FontFamilyProperty(
                    default="default"
                )
            )
        )
    ),
    title="title",
    visibility="visibility"
)