Package software.amazon.awscdk.services.workspaces

Interface CfnWorkspacesPoolProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspacesPoolProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:19.595Z")
@Stability(Stable)
public interface CfnWorkspacesPoolProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkspacesPool.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.workspaces.*;
 CfnWorkspacesPoolProps cfnWorkspacesPoolProps = CfnWorkspacesPoolProps.builder()
         .bundleId("bundleId")
         .capacity(CapacityProperty.builder()
                 .desiredUserSessions(123)
                 .build())
         .directoryId("directoryId")
         .poolName("poolName")
         // the properties below are optional
         .applicationSettings(ApplicationSettingsProperty.builder()
                 .status("status")
                 // the properties below are optional
                 .settingsGroup("settingsGroup")
                 .build())
         .description("description")
         .runningMode("runningMode")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeoutSettings(TimeoutSettingsProperty.builder()
                 .disconnectTimeoutInSeconds(123)
                 .idleDisconnectTimeoutInSeconds(123)
                 .maxUserDurationInSeconds(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkspacesPoolProps.Builder	A builder for CfnWorkspacesPoolProps
static final class	CfnWorkspacesPoolProps.Jsii$Proxy	An implementation for CfnWorkspacesPoolProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkspacesPoolProps.Builder	builder()
default Object	getApplicationSettings()	The persistent application settings for users of the pool.
String	getBundleId()	The identifier of the bundle used by the pool.
Object	getCapacity()	Describes the user capacity for the pool.
default String	getDescription()	The description of the pool.
String	getDirectoryId()	The identifier of the directory used by the pool.
String	getPoolName()	The name of the pool.
default String	getRunningMode()	The running mode of the pool.
default List<CfnTag>	getTags()	Deprecated. this property has been deprecated
default Object	getTimeoutSettings()	The amount of time that a pool session remains active after users disconnect.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBundleId

@Stability(Stable)
@NotNull
String getBundleId()

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

getCapacity

@Stability(Stable)
@NotNull
Object getCapacity()

Describes the user capacity for the pool.

Returns union: either IResolvable or CfnWorkspacesPool.CapacityProperty

See Also:

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

getDirectoryId

@Stability(Stable)
@NotNull
String getDirectoryId()

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

getPoolName

@Stability(Stable)
@NotNull
String getPoolName()

The name of the pool.

See Also:

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

getApplicationSettings

@Stability(Stable)
@Nullable
default Object getApplicationSettings()

The persistent application settings for users of the pool.

Returns union: either IResolvable or CfnWorkspacesPool.ApplicationSettingsProperty

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the pool.

See Also:

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

getRunningMode

@Stability(Stable)
@Nullable
default String getRunningMode()

The running mode of the pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html#cfn-workspaces-workspacespool-runningmode

getTags

@Stability(Deprecated)
@Deprecated
@Nullable
default List<CfnTag> getTags()

Deprecated.

this property has been deprecated

See Also:

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

getTimeoutSettings

@Stability(Stable)
@Nullable
default Object getTimeoutSettings()

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.

Returns union: either IResolvable or CfnWorkspacesPool.TimeoutSettingsProperty

See Also:

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

builder

@Stability(Stable)
static CfnWorkspacesPoolProps.Builder builder()

Returns:

a CfnWorkspacesPoolProps.Builder of CfnWorkspacesPoolProps