AWS::WorkSpaces::WorkspacesPool

WorkSpaces WorkspacesPool

Resource Type definition for AWS::WorkSpaces::WorkspacesPool

Properties

9 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`BundleId`	`string`	Required
`Capacity`	`Capacity`	Required
`DirectoryId`	`string`	Required
`PoolName`	`string`	RequiredCreate-only
`ApplicationSettings`	`ApplicationSettings`
`Description`	`string`
`RunningMode`	`string`
`Tags`	`Array<Tag>`	Deprecated
`TimeoutSettings`	`TimeoutSettings`

Return Values

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

Attribute	Type	Description
`CreatedAt`	`string`	-
`PoolArn`	`string`	-
`PoolId`	`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::WorkspacesPool

Resources:
  MyResource:
    Type: AWS::WorkSpaces::WorkspacesPool
    Properties:
      PoolName: "my-poolname"
      BundleId: "my-bundleid"
      DirectoryId: "my-directoryid"
      Capacity: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

workspaces:CreateWorkspacesPoolworkspaces:DescribeWorkspacesPoolsworkspaces:CreateTags

read

workspaces:DescribeWorkspacesPoolsworkspaces:DescribeTags

update

workspaces:UpdateWorkspacesPoolworkspaces:CreateTagsworkspaces:DeleteTagsworkspaces:DescribeWorkspacesPoolsworkspaces:DescribeTags

delete

workspaces:DescribeWorkspacesPoolsworkspaces:TerminateWorkspacesPoolworkspaces:DeleteTags

list

workspaces:DescribeWorkspacesPoolsworkspaces: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

Properties12

Required4

TaggingSupported

Primary IDPoolId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

PoolName

Related Resources

External Links

AWS Documentation