interface CfnWorkspacesPoolProps

Language	Type name
.NET	Amazon.CDK.AWS.WorkSpaces.CfnWorkspacesPoolProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsworkspaces#CfnWorkspacesPoolProps
Java	software.amazon.awscdk.services.workspaces.CfnWorkspacesPoolProps
Python	aws_cdk.aws_workspaces.CfnWorkspacesPoolProps
TypeScript	aws-cdk-lib » aws_workspaces » CfnWorkspacesPoolProps

Properties for defining a CfnWorkspacesPool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html

Example

// 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',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeoutSettings: {
    disconnectTimeoutInSeconds: 123,
    idleDisconnectTimeoutInSeconds: 123,
    maxUserDurationInSeconds: 123,
  },
};

Properties

Name	Type	Description
bundleId	string	The identifier of the bundle used by the pool.
capacity	IResolvable | CapacityProperty	Describes the user capacity for the pool.
directoryId	string	The identifier of the directory used by the pool.
poolName	string	The name of the pool.
applicationSettings?	IResolvable | ApplicationSettingsProperty	The persistent application settings for users of the pool.
description?	string	The description of the pool.
tags?⚠️	CfnTag[]
timeoutSettings?	IResolvable | TimeoutSettingsProperty	The amount of time that a pool session remains active after users disconnect.

---

bundleId

Type: string

The identifier of the bundle used by the pool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-bundleid

---

capacity

Type: IResolvable | CapacityProperty

Describes the user capacity for the pool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-capacity

---

directoryId

Type: string

The identifier of the directory used by the pool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-directoryid

---

poolName

Type: string

The name of the pool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-poolname

---

applicationSettings?

Type: IResolvable | ApplicationSettingsProperty (optional)

The persistent application settings for users of the pool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-applicationsettings

---

description?

Type: string (optional)

The description of the pool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-description

---

tags?⚠️

⚠️ Deprecated: this property has been deprecated

Type: CfnTag[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-tags

---

timeoutSettings?

Type: IResolvable | TimeoutSettingsProperty (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-timeoutsettings