# CfnWorkspaceProps

Properties for defining a `CfnWorkspace`.

Extends: CfnWorkspaceProps
Used as props by: CfnWorkspace

- Source: Generated code
- Type last changed: v2.233.0 · 18 Dec 2025

## Example

```ts
// 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

- `associations`: string[] — The resource ARNs associated with the workspace.

- `description`: string — The description of the workspace.

- `instanceArn`: string (required) — The Amazon Resource Name (ARN) of the instance.

- `media`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.MediaItemProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_connect.CfnWorkspace.MediaItemProperty.html)[] — The media items for the workspace.

- `name`: string (required) — The name of the workspace.

- `pages`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.WorkspacePageProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_connect.CfnWorkspace.WorkspacePageProperty.html)[] — The pages associated with the workspace.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The tags used to organize, track, or control access for the workspace.

- `theme`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnWorkspace.WorkspaceThemeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_connect.CfnWorkspace.WorkspaceThemeProperty.html) — 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.

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