Interface CfnWorkspaceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnWorkspaceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
date="2025-12-18T18:20:07.804Z")
@Stability(Stable)
public interface CfnWorkspaceProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnWorkspace.
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.*;
CfnWorkspaceProps cfnWorkspaceProps = CfnWorkspaceProps.builder()
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnWorkspacePropsstatic final classAn implementation forCfnWorkspaceProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnWorkspaceProps.Builderbuilder()The resource ARNs associated with the workspace.default StringThe description of the workspace.The Amazon Resource Name (ARN) of the instance.default ObjectgetMedia()The media items for the workspace.getName()The name of the workspace.default ObjectgetPages()The pages associated with the workspace.getTags()The tags used to organize, track, or control access for the workspace.default ObjectgetTheme()The theme configuration for the workspace, including colors and styling.default StringgetTitle()The title displayed for the workspace.default StringControls who can access the workspace.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getInstanceArn
The Amazon Resource Name (ARN) of the instance.- See Also:
-
getName
The name of the workspace.- See Also:
-
getAssociations
The resource ARNs associated with the workspace.- See Also:
-
getDescription
The description of the workspace.- See Also:
-
getMedia
The media items for the workspace.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnWorkspace.MediaItemProperty>- See Also:
-
getPages
The pages associated with the workspace.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnWorkspace.WorkspacePageProperty>- See Also:
-
getTags
The tags used to organize, track, or control access for the workspace.- See Also:
-
getTheme
The theme configuration for the workspace, including colors and styling.Returns union: either
IResolvableorCfnWorkspace.WorkspaceThemeProperty- See Also:
-
getTitle
The title displayed for the workspace.- See Also:
-
getVisibility
Controls who can access the workspace.Valid values are:
ALL(all users),ASSIGNED(only assigned users and routing profiles), andNONE(not visible).- See Also:
-
builder
- Returns:
- a
CfnWorkspaceProps.BuilderofCfnWorkspaceProps
-