Package software.amazon.awscdk.cfnpropertymixins.services.workspaces

Interface CfnWorkspacesPoolMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspacesPoolMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:06.320Z")
@Stability(Stable)
public interface CfnWorkspacesPoolMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnWorkspacesPoolPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.workspaces.*;
 CfnWorkspacesPoolMixinProps cfnWorkspacesPoolMixinProps = CfnWorkspacesPoolMixinProps.builder()
         .applicationSettings(ApplicationSettingsProperty.builder()
                 .settingsGroup("settingsGroup")
                 .status("status")
                 .build())
         .bundleId("bundleId")
         .capacity(CapacityProperty.builder()
                 .desiredUserSessions(123)
                 .build())
         .description("description")
         .directoryId("directoryId")
         .poolName("poolName")
         .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	CfnWorkspacesPoolMixinProps.Builder	A builder for CfnWorkspacesPoolMixinProps
static final class	CfnWorkspacesPoolMixinProps.Jsii$Proxy	An implementation for CfnWorkspacesPoolMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkspacesPoolMixinProps.Builder	builder()
default Object	getApplicationSettings()	The persistent application settings for users of the pool.
default String	getBundleId()	The identifier of the bundle used by the pool.
default Object	getCapacity()	Describes the user capacity for the pool.
default String	getDescription()	The description of the pool.
default String	getDirectoryId()	The identifier of the directory used by the pool.
default 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

getApplicationSettings

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

The persistent application settings for users of the pool.

Returns union: either IResolvable or CfnWorkspacesPoolPropsMixin.ApplicationSettingsProperty

See Also:

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

getBundleId

@Stability(Stable)
@Nullable
default 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)
@Nullable
default Object getCapacity()

Describes the user capacity for the pool.

Returns union: either IResolvable or CfnWorkspacesPoolPropsMixin.CapacityProperty

See Also:

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

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

getDirectoryId

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

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 CfnWorkspacesPoolPropsMixin.TimeoutSettingsProperty

See Also:

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

builder

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

Returns:

a CfnWorkspacesPoolMixinProps.Builder of CfnWorkspacesPoolMixinProps