CfnWorkspace

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

Bases: CfnResource

Contains 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

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 = connect.CfnWorkspace(self, "MyCfnWorkspace",
    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"
)

Create a new AWS::Connect::Workspace.

Parameters:

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

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

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

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::Connect::Workspace'
associations

The resource ARNs associated with the workspace.

attr_arn

The Amazon Resource Name (ARN) of the workspace.

CloudformationAttribute:

Arn

attr_id

The unique identifier of the workspace.

CloudformationAttribute:

Id

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.

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.

description

The description of the workspace.

env
instance_arn

The Amazon Resource Name (ARN) of the instance.

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.

media

The media items for the workspace.

name

The name of the workspace.

node

The tree node.

pages

The pages associated with the workspace.

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 used to organize, track, or control access for the workspace.

theme

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

title

The title displayed for the workspace.

visibility

Controls who can access the workspace.

workspace_ref

A reference to a Workspace resource.

Static Methods

classmethod arn_for_workspace(resource)
Parameters:

resource (IWorkspaceRef)

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_workspace(x)

Checks whether the given object is a CfnWorkspace.

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.

FontFamilyProperty

class CfnWorkspace.FontFamilyProperty(*, default=None)

Bases: object

Contains font family configuration for workspace themes.

Parameters:

default (Optional[str]) – The default font family to use in the workspace theme.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-fontfamily.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_connect as connect

font_family_property = connect.CfnWorkspace.FontFamilyProperty(
    default="default"
)

Attributes

default

The default font family to use in the workspace theme.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-fontfamily.html#cfn-connect-workspace-fontfamily-default

MediaItemProperty

class CfnWorkspace.MediaItemProperty(*, type, source=None)

Bases: object

Contains information about a media asset used in a workspace.

Parameters:

  • type (str) – The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL .

  • source (Optional[str]) – The source URL or data for the media asset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-mediaitem.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_connect as connect

media_item_property = connect.CfnWorkspace.MediaItemProperty(
    type="type",

    # the properties below are optional
    source="source"
)

Attributes

source

The source URL or data for the media asset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-mediaitem.html#cfn-connect-workspace-mediaitem-source

type

The type of media.

Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-mediaitem.html#cfn-connect-workspace-mediaitem-type

PaletteCanvasProperty

class CfnWorkspace.PaletteCanvasProperty(*, active_background=None, container_background=None, page_background=None)

Bases: object

Contains 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettecanvas.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_connect as connect

palette_canvas_property = connect.CfnWorkspace.PaletteCanvasProperty(
    active_background="activeBackground",
    container_background="containerBackground",
    page_background="pageBackground"
)

Attributes

active_background

The background color for active elements.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettecanvas.html#cfn-connect-workspace-palettecanvas-activebackground

container_background

The background color for container elements.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettecanvas.html#cfn-connect-workspace-palettecanvas-containerbackground

page_background

The background color for page elements.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettecanvas.html#cfn-connect-workspace-palettecanvas-pagebackground

PaletteHeaderProperty

class CfnWorkspace.PaletteHeaderProperty(*, background=None, invert_actions_colors=None, text=None, text_hover=None)

Bases: object

Contains 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteheader.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_connect as connect

palette_header_property = connect.CfnWorkspace.PaletteHeaderProperty(
    background="background",
    invert_actions_colors=False,
    text="text",
    text_hover="textHover"
)

Attributes

background

The background color of the header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteheader.html#cfn-connect-workspace-paletteheader-background

invert_actions_colors

Whether to invert the colors of action buttons in the header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteheader.html#cfn-connect-workspace-paletteheader-invertactionscolors

text

The text color in the header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteheader.html#cfn-connect-workspace-paletteheader-text

text_hover

The text color when hovering over header elements.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteheader.html#cfn-connect-workspace-paletteheader-texthover

PaletteNavigationProperty

class CfnWorkspace.PaletteNavigationProperty(*, background=None, invert_actions_colors=None, text=None, text_active=None, text_background_active=None, text_background_hover=None, text_hover=None)

Bases: object

Contains color configuration for navigation elements in a workspace theme.

Parameters:

  • background (Optional[str]) – The background color of the navigation area.

  • invert_actions_colors (Union[bool, IResolvable, None]) – Whether to invert the colors of action buttons in the navigation area.

  • text (Optional[str]) – The text color in the navigation area.

  • text_active (Optional[str]) – The text color for active navigation items.

  • text_background_active (Optional[str]) – The background color for active navigation items.

  • text_background_hover (Optional[str]) – The background color when hovering over navigation text.

  • text_hover (Optional[str]) – The text color when hovering over navigation items.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettenavigation.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_connect as connect

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

Attributes

background

The background color of the navigation area.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettenavigation.html#cfn-connect-workspace-palettenavigation-background

invert_actions_colors

Whether to invert the colors of action buttons in the navigation area.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettenavigation.html#cfn-connect-workspace-palettenavigation-invertactionscolors

text

The text color in the navigation area.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettenavigation.html#cfn-connect-workspace-palettenavigation-text

text_active

The text color for active navigation items.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettenavigation.html#cfn-connect-workspace-palettenavigation-textactive

text_background_active

The background color for active navigation items.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettenavigation.html#cfn-connect-workspace-palettenavigation-textbackgroundactive

text_background_hover

The background color when hovering over navigation text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettenavigation.html#cfn-connect-workspace-palettenavigation-textbackgroundhover

text_hover

The text color when hovering over navigation items.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-palettenavigation.html#cfn-connect-workspace-palettenavigation-texthover

PalettePrimaryProperty

class CfnWorkspace.PalettePrimaryProperty(*, active=None, contrast_text=None, default=None)

Bases: object

Contains 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteprimary.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_connect as connect

palette_primary_property = connect.CfnWorkspace.PalettePrimaryProperty(
    active="active",
    contrast_text="contrastText",
    default="default"
)

Attributes

active

The primary color used for active states.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteprimary.html#cfn-connect-workspace-paletteprimary-active

contrast_text

The text color that contrasts with the primary color for readability.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteprimary.html#cfn-connect-workspace-paletteprimary-contrasttext

default

The default primary color used throughout the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-paletteprimary.html#cfn-connect-workspace-paletteprimary-default

WorkspacePageProperty

class CfnWorkspace.WorkspacePageProperty(*, page, resource_arn, input_data=None, slug=None)

Bases: object

Contains information about a page configuration in a workspace, including the view assigned to the page.

Parameters:

  • page (str) – The page identifier. System pages include HOME and AGENT_EXPERIENCE .

  • resource_arn (str) – The Amazon Resource Name (ARN) of the view associated with this page.

  • input_data (Optional[str]) – A JSON string containing input parameters passed to the view when the page is rendered.

  • slug (Optional[str]) – The URL-friendly identifier for the page.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacepage.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_connect as connect

workspace_page_property = connect.CfnWorkspace.WorkspacePageProperty(
    page="page",
    resource_arn="resourceArn",

    # the properties below are optional
    input_data="inputData",
    slug="slug"
)

Attributes

input_data

A JSON string containing input parameters passed to the view when the page is rendered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacepage.html#cfn-connect-workspace-workspacepage-inputdata

page

The page identifier.

System pages include HOME and AGENT_EXPERIENCE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacepage.html#cfn-connect-workspace-workspacepage-page

resource_arn

The Amazon Resource Name (ARN) of the view associated with this page.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacepage.html#cfn-connect-workspace-workspacepage-resourcearn

slug

The URL-friendly identifier for the page.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacepage.html#cfn-connect-workspace-workspacepage-slug

WorkspaceThemeConfigProperty

class CfnWorkspace.WorkspaceThemeConfigProperty(*, palette=None, typography=None)

Bases: object

Contains detailed theme configuration for a workspace, including colors, images, and typography.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemeconfig.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_connect as connect

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

Attributes

palette

The color palette configuration for the workspace theme.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemeconfig.html#cfn-connect-workspace-workspacethemeconfig-palette

typography

The typography configuration for the workspace theme.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemeconfig.html#cfn-connect-workspace-workspacethemeconfig-typography

WorkspaceThemePaletteProperty

class CfnWorkspace.WorkspaceThemePaletteProperty(*, canvas=None, header=None, navigation=None, primary=None)

Bases: object

Contains color palette configuration for different areas of a workspace.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemepalette.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_connect as connect

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

Attributes

canvas

The color configuration for the canvas area.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemepalette.html#cfn-connect-workspace-workspacethemepalette-canvas

header

The color configuration for the header area.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemepalette.html#cfn-connect-workspace-workspacethemepalette-header

navigation

The color configuration for the navigation area.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemepalette.html#cfn-connect-workspace-workspacethemepalette-navigation

primary

The primary color configuration used throughout the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemepalette.html#cfn-connect-workspace-workspacethemepalette-primary

WorkspaceThemeProperty

class CfnWorkspace.WorkspaceThemeProperty(*, dark=None, light=None)

Bases: object

Contains theme configuration for a workspace, supporting both light and dark modes.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacetheme.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_connect as connect

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

Attributes

dark

The theme configuration for dark mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacetheme.html#cfn-connect-workspace-workspacetheme-dark

light

The theme configuration for light mode.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacetheme.html#cfn-connect-workspace-workspacetheme-light

WorkspaceThemeTypographyProperty

class CfnWorkspace.WorkspaceThemeTypographyProperty(*, font_family=None)

Bases: object

Contains 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemetypography.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_connect as connect

workspace_theme_typography_property = connect.CfnWorkspace.WorkspaceThemeTypographyProperty(
    font_family=connect.CfnWorkspace.FontFamilyProperty(
        default="default"
    )
)

Attributes

font_family

The font family configuration for text in the workspace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-workspace-workspacethemetypography.html#cfn-connect-workspace-workspacethemetypography-fontfamily