We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Connect::Workspace
Create Workspace Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);@overload
def Workspace(resource_name: str,
args: WorkspaceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Workspace(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_arn: Optional[str] = None,
associations: Optional[Sequence[str]] = None,
description: Optional[str] = None,
media: Optional[Sequence[WorkspaceMediaItemArgs]] = None,
name: Optional[str] = None,
pages: Optional[Sequence[WorkspacePageArgs]] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
theme: Optional[WorkspaceThemeArgs] = None,
title: Optional[str] = None,
visibility: Optional[WorkspaceVisibility] = None)func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
public Workspace(String name, WorkspaceArgs args)
public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)
type: aws-native:connect:Workspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkspaceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Workspace Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Workspace resource accepts the following input properties:
- Instance
Arn string - The identifier of the Amazon Connect instance.
- Associations List<string>
- The resource ARNs associated with the workspace
- Description string
- The description of the workspace
- Media
List<Pulumi.
Aws Native. Connect. Inputs. Workspace Media Item> - The media items for the workspace
- Name string
- The name of the workspace.
- Pages
List<Pulumi.
Aws Native. Connect. Inputs. Workspace Page> - The pages associated with the workspace
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Theme
Pulumi.
Aws Native. Connect. Inputs. Workspace Theme - The theme configuration for the workspace
- Title string
- The title of the workspace
- Visibility
Pulumi.
Aws Native. Connect. Workspace Visibility - The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
- Instance
Arn string - The identifier of the Amazon Connect instance.
- Associations []string
- The resource ARNs associated with the workspace
- Description string
- The description of the workspace
- Media
[]Workspace
Media Item Args - The media items for the workspace
- Name string
- The name of the workspace.
- Pages
[]Workspace
Page Args - The pages associated with the workspace
-
Tag
Args - An array of key-value pairs to apply to this resource.
- Theme
Workspace
Theme Args - The theme configuration for the workspace
- Title string
- The title of the workspace
- Visibility
Workspace
Visibility - The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
- instance
Arn String - The identifier of the Amazon Connect instance.
- associations List<String>
- The resource ARNs associated with the workspace
- description String
- The description of the workspace
- media
List<Workspace
Media Item> - The media items for the workspace
- name String
- The name of the workspace.
- pages
List<Workspace
Page> - The pages associated with the workspace
- List<Tag>
- An array of key-value pairs to apply to this resource.
- theme
Workspace
Theme - The theme configuration for the workspace
- title String
- The title of the workspace
- visibility
Workspace
Visibility - The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
- instance
Arn string - The identifier of the Amazon Connect instance.
- associations string[]
- The resource ARNs associated with the workspace
- description string
- The description of the workspace
- media
Workspace
Media Item[] - The media items for the workspace
- name string
- The name of the workspace.
- pages
Workspace
Page[] - The pages associated with the workspace
- Tag[]
- An array of key-value pairs to apply to this resource.
- theme
Workspace
Theme - The theme configuration for the workspace
- title string
- The title of the workspace
- visibility
Workspace
Visibility - The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
- instance_
arn str - The identifier of the Amazon Connect instance.
- associations Sequence[str]
- The resource ARNs associated with the workspace
- description str
- The description of the workspace
- media
Sequence[Workspace
Media Item Args] - The media items for the workspace
- name str
- The name of the workspace.
- pages
Sequence[Workspace
Page Args] - The pages associated with the workspace
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- theme
Workspace
Theme Args - The theme configuration for the workspace
- title str
- The title of the workspace
- visibility
Workspace
Visibility - The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
- instance
Arn String - The identifier of the Amazon Connect instance.
- associations List<String>
- The resource ARNs associated with the workspace
- description String
- The description of the workspace
- media List<Property Map>
- The media items for the workspace
- name String
- The name of the workspace.
- pages List<Property Map>
- The pages associated with the workspace
- List<Property Map>
- An array of key-value pairs to apply to this resource.
- theme Property Map
- The theme configuration for the workspace
- title String
- The title of the workspace
- visibility "ALL" | "ASSIGNED" | "NONE"
- The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
Outputs
All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:
Supporting Types
FontFamily, FontFamilyArgs
Tag, TagArgs
A set of tags to apply to the resource.WorkspaceFontFamily, WorkspaceFontFamilyArgs
- Arial
- ARIAL
- Courier
New - COURIER_NEW
- Georgia
- GEORGIA
- Times
New Roman - TIMES_NEW_ROMAN
- Trebuchet
- TREBUCHET
- Verdana
- VERDANA
- Workspace
Font Family Arial - ARIAL
- Workspace
Font Family Courier New - COURIER_NEW
- Workspace
Font Family Georgia - GEORGIA
- Workspace
Font Family Times New Roman - TIMES_NEW_ROMAN
- Workspace
Font Family Trebuchet - TREBUCHET
- Workspace
Font Family Verdana - VERDANA
- Arial
- ARIAL
- Courier
New - COURIER_NEW
- Georgia
- GEORGIA
- Times
New Roman - TIMES_NEW_ROMAN
- Trebuchet
- TREBUCHET
- Verdana
- VERDANA
- Arial
- ARIAL
- Courier
New - COURIER_NEW
- Georgia
- GEORGIA
- Times
New Roman - TIMES_NEW_ROMAN
- Trebuchet
- TREBUCHET
- Verdana
- VERDANA
- ARIAL
- ARIAL
- COURIER_NEW
- COURIER_NEW
- GEORGIA
- GEORGIA
- TIMES_NEW_ROMAN
- TIMES_NEW_ROMAN
- TREBUCHET
- TREBUCHET
- VERDANA
- VERDANA
- "ARIAL"
- ARIAL
- "COURIER_NEW"
- COURIER_NEW
- "GEORGIA"
- GEORGIA
- "TIMES_NEW_ROMAN"
- TIMES_NEW_ROMAN
- "TREBUCHET"
- TREBUCHET
- "VERDANA"
- VERDANA
WorkspaceMediaItem, WorkspaceMediaItemArgs
- Type
Workspace
Media Type - Source string
- type
Workspace
Media Type - source String
- type
Workspace
Media Type - source string
WorkspaceMediaType, WorkspaceMediaTypeArgs
- Image
Logo Light Favicon - IMAGE_LOGO_LIGHT_FAVICON
- Image
Logo Dark Favicon - IMAGE_LOGO_DARK_FAVICON
- Image
Logo Light Horizontal - IMAGE_LOGO_LIGHT_HORIZONTAL
- Image
Logo Dark Horizontal - IMAGE_LOGO_DARK_HORIZONTAL
- Workspace
Media Type Image Logo Light Favicon - IMAGE_LOGO_LIGHT_FAVICON
- Workspace
Media Type Image Logo Dark Favicon - IMAGE_LOGO_DARK_FAVICON
- Workspace
Media Type Image Logo Light Horizontal - IMAGE_LOGO_LIGHT_HORIZONTAL
- Workspace
Media Type Image Logo Dark Horizontal - IMAGE_LOGO_DARK_HORIZONTAL
- Image
Logo Light Favicon - IMAGE_LOGO_LIGHT_FAVICON
- Image
Logo Dark Favicon - IMAGE_LOGO_DARK_FAVICON
- Image
Logo Light Horizontal - IMAGE_LOGO_LIGHT_HORIZONTAL
- Image
Logo Dark Horizontal - IMAGE_LOGO_DARK_HORIZONTAL
- Image
Logo Light Favicon - IMAGE_LOGO_LIGHT_FAVICON
- Image
Logo Dark Favicon - IMAGE_LOGO_DARK_FAVICON
- Image
Logo Light Horizontal - IMAGE_LOGO_LIGHT_HORIZONTAL
- Image
Logo Dark Horizontal - IMAGE_LOGO_DARK_HORIZONTAL
- IMAGE_LOGO_LIGHT_FAVICON
- IMAGE_LOGO_LIGHT_FAVICON
- IMAGE_LOGO_DARK_FAVICON
- IMAGE_LOGO_DARK_FAVICON
- IMAGE_LOGO_LIGHT_HORIZONTAL
- IMAGE_LOGO_LIGHT_HORIZONTAL
- IMAGE_LOGO_DARK_HORIZONTAL
- IMAGE_LOGO_DARK_HORIZONTAL
- "IMAGE_LOGO_LIGHT_FAVICON"
- IMAGE_LOGO_LIGHT_FAVICON
- "IMAGE_LOGO_DARK_FAVICON"
- IMAGE_LOGO_DARK_FAVICON
- "IMAGE_LOGO_LIGHT_HORIZONTAL"
- IMAGE_LOGO_LIGHT_HORIZONTAL
- "IMAGE_LOGO_DARK_HORIZONTAL"
- IMAGE_LOGO_DARK_HORIZONTAL
WorkspacePage, WorkspacePageArgs
- Page string
- The page identifier.
- Resource
Arn string - The Amazon Resource Name (ARN) of the resource associated with the page.
- Input
Data string - The input data for the page.
- Slug string
- The slug for the page.
- Page string
- The page identifier.
- Resource
Arn string - The Amazon Resource Name (ARN) of the resource associated with the page.
- Input
Data string - The input data for the page.
- Slug string
- The slug for the page.
- page String
- The page identifier.
- resource
Arn String - The Amazon Resource Name (ARN) of the resource associated with the page.
- input
Data String - The input data for the page.
- slug String
- The slug for the page.
- page string
- The page identifier.
- resource
Arn string - The Amazon Resource Name (ARN) of the resource associated with the page.
- input
Data string - The input data for the page.
- slug string
- The slug for the page.
- page str
- The page identifier.
- resource_
arn str - The Amazon Resource Name (ARN) of the resource associated with the page.
- input_
data str - The input data for the page.
- slug str
- The slug for the page.
- page String
- The page identifier.
- resource
Arn String - The Amazon Resource Name (ARN) of the resource associated with the page.
- input
Data String - The input data for the page.
- slug String
- The slug for the page.
WorkspacePaletteCanvas, WorkspacePaletteCanvasArgs
- Active
Background string - Container
Background string - Page
Background string
- Active
Background string - Container
Background string - Page
Background string
- active
Background String - container
Background String - page
Background String
- active
Background string - container
Background string - page
Background string
- active
Background String - container
Background String - page
Background String
WorkspacePaletteHeader, WorkspacePaletteHeaderArgs
- Background string
- Invert
Actions boolColors - Text string
- Text
Hover string
- Background string
- Invert
Actions boolColors - Text string
- Text
Hover string
- background String
- invert
Actions BooleanColors - text String
- text
Hover String
- background string
- invert
Actions booleanColors - text string
- text
Hover string
- background str
- invert_
actions_ boolcolors - text str
- text_
hover str
- background String
- invert
Actions BooleanColors - text String
- text
Hover String
WorkspacePaletteNavigation, WorkspacePaletteNavigationArgs
- Background string
- Invert
Actions boolColors - Text string
- Text
Active string - Text
Background stringActive - Text
Background stringHover - Text
Hover string
- Background string
- Invert
Actions boolColors - Text string
- Text
Active string - Text
Background stringActive - Text
Background stringHover - Text
Hover string
- background String
- invert
Actions BooleanColors - text String
- text
Active String - text
Background StringActive - text
Background StringHover - text
Hover String
- background string
- invert
Actions booleanColors - text string
- text
Active string - text
Background stringActive - text
Background stringHover - text
Hover string
- background str
- invert_
actions_ boolcolors - text str
- text_
active str - text_
background_ stractive - text_
background_ strhover - text_
hover str
- background String
- invert
Actions BooleanColors - text String
- text
Active String - text
Background StringActive - text
Background StringHover - text
Hover String
WorkspacePalettePrimary, WorkspacePalettePrimaryArgs
- Active string
- Contrast
Text string - Default string
- Active string
- Contrast
Text string - Default string
- active String
- contrast
Text String - default_ String
- active string
- contrast
Text string - default string
- active str
- contrast_
text str - default str
- active String
- contrast
Text String - default String
WorkspaceTheme, WorkspaceThemeArgs
The theme configuration for the Connect workspaceWorkspaceThemeConfig, WorkspaceThemeConfigArgs
WorkspaceThemePalette, WorkspaceThemePaletteArgs
WorkspaceThemeTypography, WorkspaceThemeTypographyArgs
WorkspaceVisibility, WorkspaceVisibilityArgs
- All
- ALL
- Assigned
- ASSIGNED
- None
- NONE
- Workspace
Visibility All - ALL
- Workspace
Visibility Assigned - ASSIGNED
- Workspace
Visibility None - NONE
- All
- ALL
- Assigned
- ASSIGNED
- None
- NONE
- All
- ALL
- Assigned
- ASSIGNED
- None
- NONE
- ALL
- ALL
- ASSIGNED
- ASSIGNED
- NONE
- NONE
- "ALL"
- ALL
- "ASSIGNED"
- ASSIGNED
- "NONE"
- NONE
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
