CfnWorkspaceProps Struct
Properties for defining a CfnWorkspace.
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
associationsoptionalstring[]associationsoptionaltyping.List[str]associationsoptionalList<String>Associationsoptionalstring[]Associationsoptional*[]*string#The resource ARNs associated with the workspace.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description of the workspace.
The Amazon Resource Name (ARN) of the instance.
mediaoptionalIResolvable | IResolvable | CfnWorkspace.MediaItemProperty[]mediaoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MediaItemProperty]]]mediaoptionalIResolvableMediaoptionalIResolvableMediaoptionalinterface{}#The media items for the workspace.
The name of the workspace.
pagesoptionalIResolvable | IResolvable | CfnWorkspace.WorkspacePageProperty[]pagesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, WorkspacePageProperty]]]pagesoptionalIResolvablePagesoptionalIResolvablePagesoptionalinterface{}#The pages associated with the workspace.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#The tags used to organize, track, or control access for the workspace.
themeoptionalIResolvable | CfnWorkspace.WorkspaceThemePropertythemeoptionaltyping.Union[IResolvable, WorkspaceThemeProperty]themeoptionalIResolvableThemeoptionalIResolvableThemeoptionalinterface{}#The theme configuration for the workspace, including colors and styling.
The title displayed for the workspace.
visibilityoptionalstringvisibilityoptionalstrvisibilityoptionalStringVisibilityoptionalstringVisibilityoptional*string#Controls who can access the workspace.
Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).