CfnWorkspacesPoolProps Struct
Properties for defining a CfnWorkspacesPool.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspaces as workspaces } from 'aws-cdk-lib';
const cfnWorkspacesPoolProps: workspaces.CfnWorkspacesPoolProps = {
bundleId: 'bundleId',
capacity: {
desiredUserSessions: 123,
},
directoryId: 'directoryId',
poolName: 'poolName',
// the properties below are optional
applicationSettings: {
status: 'status',
// the properties below are optional
settingsGroup: 'settingsGroup',
},
description: 'description',
runningMode: 'runningMode',
tags: [{
key: 'key',
value: 'value',
}],
timeoutSettings: {
disconnectTimeoutInSeconds: 123,
idleDisconnectTimeoutInSeconds: 123,
maxUserDurationInSeconds: 123,
},
};
Properties
applicationSettingsoptionalIResolvable | CfnWorkspacesPool.ApplicationSettingsPropertyapplication_settingsoptionaltyping.Union[IResolvable, ApplicationSettingsProperty]applicationSettingsoptionalIResolvableApplicationSettingsoptionalIResolvableApplicationSettingsoptionalinterface{}#The persistent application settings for users of the pool.
The identifier of the bundle used by the pool.
capacityIResolvable | CfnWorkspacesPool.CapacityPropertycapacitytyping.Union[IResolvable, CapacityProperty]capacityIResolvableCapacityIResolvableCapacityinterface{}required#Describes the user capacity for the pool.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#The description of the pool.
The identifier of the directory used by the pool.
The name of the pool.
runningModeoptionalstringrunning_modeoptionalstrrunningModeoptionalStringRunningModeoptionalstringRunningModeoptional*string#The running mode of the pool.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTagdeprecated#this property has been deprecated
timeoutSettingsoptionalIResolvable | CfnWorkspacesPool.TimeoutSettingsPropertytimeout_settingsoptionaltyping.Union[IResolvable, TimeoutSettingsProperty]timeoutSettingsoptionalIResolvableTimeoutSettingsoptionalIResolvableTimeoutSettingsoptionalinterface{}#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.