AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::WorkSpaces::WorkspacesPool

CfnWorkspacesPool

Describes a pool of WorkSpaces.

Import

import { CfnWorkspacesPool } from 'aws-cdk-lib/aws-workspaces';

Or use the module namespace:

import * as workspaces from 'aws-cdk-lib/aws-workspaces';
// workspaces.CfnWorkspacesPool

Properties

Configuration passed to the constructor as CfnWorkspacesPoolProps.

bundleIdRequired
string

The identifier of the bundle used by the pool.

capacityRequired
IResolvable | CapacityProperty

Describes the user capacity for the pool.

directoryIdRequired
string

The identifier of the directory used by the pool.

poolNameRequired
string

The name of the pool.

applicationSettingsOptional
IResolvable | ApplicationSettingsProperty

The persistent application settings for users of the pool.

descriptionOptional
string

The description of the pool.

runningModeOptional
string

The running mode of the pool.

tagsOptionalDeprecated
CfnTag[]

Deprecated: this property has been deprecated

timeoutSettingsOptional
IResolvable | TimeoutSettingsProperty

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::WorkSpaces::WorkspacesPoolView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-workspaces
CFN TypeAWS::WorkSpaces::WorkspacesPool
Properties9

Related Constructs

Explore This Service

External Links