interface CfnWorkspaceProps

Language	Type name
.NET	Amazon.CDK.AWS.Connect.CfnWorkspaceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsconnect#CfnWorkspaceProps
Java	software.amazon.awscdk.services.connect.CfnWorkspaceProps
Python	aws_cdk.aws_connect.CfnWorkspaceProps
TypeScript	aws-cdk-lib » aws_connect » CfnWorkspaceProps

Properties for defining a CfnWorkspace.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';
const cfnWorkspaceProps: connect.CfnWorkspaceProps = {
  instanceArn: 'instanceArn',
  name: 'name',

  // the properties below are optional
  associations: ['associations'],
  description: 'description',
  media: [{
    type: 'type',

    // the properties below are optional
    source: 'source',
  }],
  pages: [{
    page: 'page',
    resourceArn: 'resourceArn',

    // the properties below are optional
    inputData: 'inputData',
    slug: 'slug',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  theme: {
    dark: {
      palette: {
        canvas: {
          activeBackground: 'activeBackground',
          containerBackground: 'containerBackground',
          pageBackground: 'pageBackground',
        },
        header: {
          background: 'background',
          invertActionsColors: false,
          text: 'text',
          textHover: 'textHover',
        },
        navigation: {
          background: 'background',
          invertActionsColors: false,
          text: 'text',
          textActive: 'textActive',
          textBackgroundActive: 'textBackgroundActive',
          textBackgroundHover: 'textBackgroundHover',
          textHover: 'textHover',
        },
        primary: {
          active: 'active',
          contrastText: 'contrastText',
          default: 'default',
        },
      },
      typography: {
        fontFamily: {
          default: 'default',
        },
      },
    },
    light: {
      palette: {
        canvas: {
          activeBackground: 'activeBackground',
          containerBackground: 'containerBackground',
          pageBackground: 'pageBackground',
        },
        header: {
          background: 'background',
          invertActionsColors: false,
          text: 'text',
          textHover: 'textHover',
        },
        navigation: {
          background: 'background',
          invertActionsColors: false,
          text: 'text',
          textActive: 'textActive',
          textBackgroundActive: 'textBackgroundActive',
          textBackgroundHover: 'textBackgroundHover',
          textHover: 'textHover',
        },
        primary: {
          active: 'active',
          contrastText: 'contrastText',
          default: 'default',
        },
      },
      typography: {
        fontFamily: {
          default: 'default',
        },
      },
    },
  },
  title: 'title',
  visibility: 'visibility',
};

Properties

Name	Type	Description
instanceArn	string	The Amazon Resource Name (ARN) of the instance.
name	string	The name of the workspace.
associations?	string[]	The resource ARNs associated with the workspace.
description?	string	The description of the workspace.
media?	IResolvable | (IResolvable | MediaItemProperty)[]	The media items for the workspace.
pages?	IResolvable | (IResolvable | WorkspacePageProperty)[]	The pages associated with the workspace.
tags?	CfnTag[]	The tags used to organize, track, or control access for the workspace.
theme?	IResolvable | WorkspaceThemeProperty	The theme configuration for the workspace, including colors and styling.
title?	string	The title displayed for the workspace.
visibility?	string	Controls who can access the workspace.

---

instanceArn

Type: string

The Amazon Resource Name (ARN) of the instance.

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

---

name

Type: string

The name of the workspace.

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

---

associations?

Type: string[] (optional)

The resource ARNs associated with the workspace.

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

---

description?

Type: string (optional)

The description of the workspace.

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

---

media?

Type: IResolvable | (IResolvable | MediaItemProperty)[] (optional)

The media items for the workspace.

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

---

pages?

Type: IResolvable | (IResolvable | WorkspacePageProperty)[] (optional)

The pages associated with the workspace.

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

---

tags?

Type: CfnTag[] (optional)

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

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

---

theme?

Type: IResolvable | WorkspaceThemeProperty (optional)

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

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

---

title?

Type: string (optional)

The title displayed for the workspace.

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

---

visibility?

Type: string (optional)

Controls who can access the workspace.

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

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