AWS::WorkSpaces::WorkspacesPool - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::WorkSpaces::WorkspacesPool

Describes a pool of WorkSpaces.

Syntax

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

JSON

{
  "Type" : "AWS::WorkSpaces::WorkspacesPool",
  "Properties" : {
      "ApplicationSettings" : ApplicationSettings,
      "BundleId" : String,
      "Capacity" : Capacity,
      "Description" : String,
      "DirectoryId" : String,
      "PoolName" : String,
      "RunningMode" : String,
      "TimeoutSettings" : TimeoutSettings
    }
}

YAML

Type: AWS::WorkSpaces::WorkspacesPool
Properties:
  ApplicationSettings: 
    ApplicationSettings
  BundleId: String
  Capacity: 
    Capacity
  Description: String
  DirectoryId: String
  PoolName: String
  RunningMode: String
  TimeoutSettings: 
    TimeoutSettings

Properties

ApplicationSettings

The persistent application settings for users of the pool.

Required: No

Type: ApplicationSettings

Update requires: No interruption

BundleId

The identifier of the bundle used by the pool.

Required: Yes

Type: String

Pattern: ^wsb-[0-9a-z]{8,63}$

Update requires: No interruption

Capacity

Describes the user capacity for the pool.

Required: Yes

Type: Capacity

Update requires: No interruption

Description

The description of the pool.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_./() -]+$

Minimum: 1

Maximum: 255

Update requires: No interruption

DirectoryId

The identifier of the directory used by the pool.

Required: Yes

Type: String

Pattern: ^wsd-[0-9a-z]{8,63}$

Minimum: 10

Maximum: 65

Update requires: No interruption

PoolName

The name of the pool.

Required: Yes

Type: String

Pattern: ^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$

Update requires: Replacement

RunningMode

The running mode of the pool.

Required: No

Type: String

Allowed values: ALWAYS_ON | AUTO_STOP

Update requires: No interruption

TimeoutSettings

The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

Required: No

Type: TimeoutSettings

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The time the pool was created.

PoolArn

The Amazon Resource Name (ARN) for the pool.

PoolId

The identifier of the pool.