AWS::Connect::Workspace - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Connect::Workspace

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

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Connect::Workspace",
  "Properties" : {
      "Associations" : [ String, ... ],
      "Description" : String,
      "InstanceArn" : String,
      "Media" : [ MediaItem, ... ],
      "Name" : String,
      "Pages" : [ WorkspacePage, ... ],
      "Tags" : [ Tag, ... ],
      "Theme" : WorkspaceTheme,
      "Title" : String,
      "Visibility" : String
    }
}

YAML

Type: AWS::Connect::Workspace
Properties:
  Associations: 
    - String
  Description: String
  InstanceArn: String
  Media: 
    - MediaItem
  Name: String
  Pages: 
    - WorkspacePage
  Tags: 
    - Tag
  Theme: 
    WorkspaceTheme
  Title: String
  Visibility: String

Properties

Associations

Property description not available.

Required: No

Type: Array of String

Maximum: 2048

Update requires: No interruption

Description

The description of the workspace.

Required: No

Type: String

Pattern: ^[\P{C} ]*$

Minimum: 0

Maximum: 500

Update requires: No interruption

InstanceArn

The Amazon Resource Name (ARN) of the instance.

Required: Yes

Type: String

Pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$

Update requires: Replacement

Media

Property description not available.

Required: No

Type: Array of MediaItem

Maximum: 4

Update requires: No interruption

Name

The name of the workspace.

Required: Yes

Type: String

Pattern: .*\S.*

Minimum: 1

Maximum: 127

Update requires: No interruption

Pages

Property description not available.

Required: No

Type: Array of WorkspacePage

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Theme

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

Required: No

Type: WorkspaceTheme

Update requires: No interruption

Title

The title displayed for the workspace.

Required: No

Type: String

Pattern: ^[\P{C}]*$

Minimum: 0

Maximum: 127

Update requires: No interruption

Visibility

Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).

Required: No

Type: String

Allowed values: ALL | ASSIGNED | NONE

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the workspace.

Id

The unique identifier of the workspace.