AWS::WorkSpaces::Workspace

WorkSpaces Workspace

Resource Type definition for AWS::WorkSpaces::Workspace

Properties

8 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`BundleId`	`string`	Required
`DirectoryId`	`string`	RequiredCreate-only
`UserName`	`string`	RequiredCreate-only
`RootVolumeEncryptionEnabled`	`boolean`
`Tags`	`Array<Tag>`
`UserVolumeEncryptionEnabled`	`boolean`
`VolumeEncryptionKey`	`string`
`WorkspaceProperties`	`WorkspaceProperties`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Id`	`string`	-
`WorkspaceId`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::WorkSpaces::Workspace

Resources:
  MyResource:
    Type: AWS::WorkSpaces::Workspace
    Properties:
      BundleId: "my-bundleid"
      DirectoryId: "my-directoryid"
      UserName: "my-username"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

workspaces:DescribeWorkspacesworkspaces:CreateWorkspacesworkspaces:CreateTagskms:CreateGrantkms:DescribeKey

read

workspaces:DescribeWorkspacesworkspaces:DescribeTags

update

workspaces:DescribeWorkspacesworkspaces:DescribeWorkspaceBundlesworkspaces:ModifyWorkspacePropertiesworkspaces:DescribeTagsworkspaces:CreateTagsworkspaces:DeleteTagskms:CreateGrantkms:DescribeKey

delete

workspaces:DescribeWorkspacesworkspaces:TerminateWorkspaces

list

workspaces:DescribeWorkspacesworkspaces:DescribeTags

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceWorkSpaces

Properties10

Required3

TaggingSupported

Primary IDWorkspaceId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

UserNameDirectoryId

Related Resources

External Links

AWS Documentation