Package software.amazon.awscdk.services.connect

Class CfnWorkspace

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.connect.CfnWorkspace

All Implemented Interfaces:

IInspectable, IWorkspaceRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:07.798Z")
@Stability(Stable)
public class CfnWorkspace
extends CfnResource
implements IInspectable, IWorkspaceRef, ITaggableV2

Contains information about a workspace, which defines the user experience by mapping views to pages.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 CfnWorkspace cfnWorkspace = CfnWorkspace.Builder.create(this, "MyCfnWorkspace")
         .instanceArn("instanceArn")
         .name("name")
         // the properties below are optional
         .associations(List.of("associations"))
         .description("description")
         .media(List.of(MediaItemProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .source("source")
                 .build()))
         .pages(List.of(WorkspacePageProperty.builder()
                 .page("page")
                 .resourceArn("resourceArn")
                 // the properties below are optional
                 .inputData("inputData")
                 .slug("slug")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .theme(WorkspaceThemeProperty.builder()
                 .dark(WorkspaceThemeConfigProperty.builder()
                         .palette(WorkspaceThemePaletteProperty.builder()
                                 .canvas(PaletteCanvasProperty.builder()
                                         .activeBackground("activeBackground")
                                         .containerBackground("containerBackground")
                                         .pageBackground("pageBackground")
                                         .build())
                                 .header(PaletteHeaderProperty.builder()
                                         .background("background")
                                         .invertActionsColors(false)
                                         .text("text")
                                         .textHover("textHover")
                                         .build())
                                 .navigation(PaletteNavigationProperty.builder()
                                         .background("background")
                                         .invertActionsColors(false)
                                         .text("text")
                                         .textActive("textActive")
                                         .textBackgroundActive("textBackgroundActive")
                                         .textBackgroundHover("textBackgroundHover")
                                         .textHover("textHover")
                                         .build())
                                 .primary(PalettePrimaryProperty.builder()
                                         .active("active")
                                         .contrastText("contrastText")
                                         .default("default")
                                         .build())
                                 .build())
                         .typography(WorkspaceThemeTypographyProperty.builder()
                                 .fontFamily(FontFamilyProperty.builder()
                                         .default("default")
                                         .build())
                                 .build())
                         .build())
                 .light(WorkspaceThemeConfigProperty.builder()
                         .palette(WorkspaceThemePaletteProperty.builder()
                                 .canvas(PaletteCanvasProperty.builder()
                                         .activeBackground("activeBackground")
                                         .containerBackground("containerBackground")
                                         .pageBackground("pageBackground")
                                         .build())
                                 .header(PaletteHeaderProperty.builder()
                                         .background("background")
                                         .invertActionsColors(false)
                                         .text("text")
                                         .textHover("textHover")
                                         .build())
                                 .navigation(PaletteNavigationProperty.builder()
                                         .background("background")
                                         .invertActionsColors(false)
                                         .text("text")
                                         .textActive("textActive")
                                         .textBackgroundActive("textBackgroundActive")
                                         .textBackgroundHover("textBackgroundHover")
                                         .textHover("textHover")
                                         .build())
                                 .primary(PalettePrimaryProperty.builder()
                                         .active("active")
                                         .contrastText("contrastText")
                                         .default("default")
                                         .build())
                                 .build())
                         .typography(WorkspaceThemeTypographyProperty.builder()
                                 .fontFamily(FontFamilyProperty.builder()
                                         .default("default")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .title("title")
         .visibility("visibility")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnWorkspace.Builder	A fluent builder for CfnWorkspace.
static interface	CfnWorkspace.FontFamilyProperty	Contains font family configuration for workspace themes.
static interface	CfnWorkspace.MediaItemProperty	Contains information about a media asset used in a workspace.
static interface	CfnWorkspace.PaletteCanvasProperty	Contains color configuration for canvas elements in a workspace theme.
static interface	CfnWorkspace.PaletteHeaderProperty	Contains color configuration for header elements in a workspace theme.
static interface	CfnWorkspace.PaletteNavigationProperty	Contains color configuration for navigation elements in a workspace theme.
static interface	CfnWorkspace.PalettePrimaryProperty	Contains primary color configuration for a workspace theme.
static interface	CfnWorkspace.WorkspacePageProperty	Contains information about a page configuration in a workspace, including the view assigned to the page.
static interface	CfnWorkspace.WorkspaceThemeConfigProperty	Contains detailed theme configuration for a workspace, including colors, images, and typography.
static interface	CfnWorkspace.WorkspaceThemePaletteProperty	Contains color palette configuration for different areas of a workspace.
static interface	CfnWorkspace.WorkspaceThemeProperty	Contains theme configuration for a workspace, supporting both light and dark modes.
static interface	CfnWorkspace.WorkspaceThemeTypographyProperty	Contains typography configuration for a workspace theme.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.connect.IWorkspaceRef

IWorkspaceRef.Jsii$Default, IWorkspaceRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnWorkspace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkspace(software.amazon.jsii.JsiiObjectRef objRef)
	CfnWorkspace(software.constructs.Construct scope, String id, CfnWorkspaceProps props)	Create a new AWS::Connect::Workspace.

Method Summary

Modifier and Type	Method	Description
static String	arnForWorkspace(IWorkspaceRef resource)
List<String>	getAssociations()	The resource ARNs associated with the workspace.
String	getAttrArn()	The Amazon Resource Name (ARN) of the workspace.
String	getAttrId()	The unique identifier of the workspace.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the workspace.
String	getInstanceArn()	The Amazon Resource Name (ARN) of the instance.
Object	getMedia()	The media items for the workspace.
String	getName()	The name of the workspace.
Object	getPages()	The pages associated with the workspace.
List<CfnTag>	getTags()	The tags used to organize, track, or control access for the workspace.
Object	getTheme()	The theme configuration for the workspace, including colors and styling.
String	getTitle()	The title displayed for the workspace.
String	getVisibility()	Controls who can access the workspace.
WorkspaceReference	getWorkspaceRef()	A reference to a Workspace resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnWorkspace(Object x)	Checks whether the given object is a CfnWorkspace.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssociations(List<String> value)	The resource ARNs associated with the workspace.
void	setDescription(String value)	The description of the workspace.
void	setInstanceArn(String value)	The Amazon Resource Name (ARN) of the instance.
void	setMedia(List<Object> value)	The media items for the workspace.
void	setMedia(IResolvable value)	The media items for the workspace.
void	setName(String value)	The name of the workspace.
void	setPages(List<Object> value)	The pages associated with the workspace.
void	setPages(IResolvable value)	The pages associated with the workspace.
void	setTags(List<CfnTag> value)	The tags used to organize, track, or control access for the workspace.
void	setTheme(IResolvable value)	The theme configuration for the workspace, including colors and styling.
void	setTheme(CfnWorkspace.WorkspaceThemeProperty value)	The theme configuration for the workspace, including colors and styling.
void	setTitle(String value)	The title displayed for the workspace.
void	setVisibility(String value)	Controls who can access the workspace.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnWorkspace

protected CfnWorkspace(software.amazon.jsii.JsiiObjectRef objRef)

CfnWorkspace

protected CfnWorkspace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnWorkspace

@Stability(Stable)
public CfnWorkspace(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnWorkspaceProps props)

Create a new AWS::Connect::Workspace.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForWorkspace

@Stability(Stable)
@NotNull
public static String arnForWorkspace(@NotNull
 IWorkspaceRef resource)

Parameters:

resource - This parameter is required.

isCfnWorkspace

@Stability(Stable)
@NotNull
public static Boolean isCfnWorkspace(@NotNull
 Object x)

Checks whether the given object is a CfnWorkspace.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the workspace.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The unique identifier of the workspace.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getWorkspaceRef

@Stability(Stable)
@NotNull
public WorkspaceReference getWorkspaceRef()

A reference to a Workspace resource.

Specified by:

getWorkspaceRef in interface IWorkspaceRef

getInstanceArn

@Stability(Stable)
@NotNull
public String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

setInstanceArn

@Stability(Stable)
public void setInstanceArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of the instance.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the workspace.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the workspace.

getAssociations

@Stability(Stable)
@Nullable
public List<String> getAssociations()

The resource ARNs associated with the workspace.

setAssociations

@Stability(Stable)
public void setAssociations(@Nullable
 List<String> value)

The resource ARNs associated with the workspace.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the workspace.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the workspace.

getMedia

@Stability(Stable)
@Nullable
public Object getMedia()

The media items for the workspace.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkspace.MediaItemProperty>

setMedia

@Stability(Stable)
public void setMedia(@Nullable
 IResolvable value)

The media items for the workspace.

setMedia

@Stability(Stable)
public void setMedia(@Nullable
 List<Object> value)

The media items for the workspace.

getPages

@Stability(Stable)
@Nullable
public Object getPages()

The pages associated with the workspace.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWorkspace.WorkspacePageProperty>

setPages

@Stability(Stable)
public void setPages(@Nullable
 IResolvable value)

The pages associated with the workspace.

setPages

@Stability(Stable)
public void setPages(@Nullable
 List<Object> value)

The pages associated with the workspace.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

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

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

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

getTheme

@Stability(Stable)
@Nullable
public Object getTheme()

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

Returns union: either IResolvable or CfnWorkspace.WorkspaceThemeProperty

setTheme

@Stability(Stable)
public void setTheme(@Nullable
 IResolvable value)

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

setTheme

@Stability(Stable)
public void setTheme(@Nullable
 CfnWorkspace.WorkspaceThemeProperty value)

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

getTitle

@Stability(Stable)
@Nullable
public String getTitle()

The title displayed for the workspace.

setTitle

@Stability(Stable)
public void setTitle(@Nullable
 String value)

The title displayed for the workspace.

getVisibility

@Stability(Stable)
@Nullable
public String getVisibility()

Controls who can access the workspace.

setVisibility

@Stability(Stable)
public void setVisibility(@Nullable
 String value)

Controls who can access the workspace.