Package software.amazon.awscdk.services.workspaces

Class CfnWorkspacesPool

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.workspaces.CfnWorkspacesPool
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IWorkspacesPoolRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:52.365Z") @Stability(Stable) public class CfnWorkspacesPool extends CfnResource implements IInspectable, IWorkspacesPoolRef, ITaggableV2
Describes a pool of WorkSpaces.

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.*;
 CfnWorkspacesPool cfnWorkspacesPool = CfnWorkspacesPool.Builder.create(this, "MyCfnWorkspacesPool")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkspacesPool

      protected CfnWorkspacesPool(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkspacesPool

      protected CfnWorkspacesPool(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkspacesPool

      @Stability(Stable) public CfnWorkspacesPool(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkspacesPoolProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromPoolId

      @Stability(Stable) @NotNull public static IWorkspacesPoolRef fromPoolId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String poolId)
      Creates a new IWorkspacesPoolRef from a poolId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      poolId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time the pool was created.

    • getAttrPoolArn

      @Stability(Stable) @NotNull public String getAttrPoolArn()
      The Amazon Resource Name (ARN) for the pool.

    • getAttrPoolId

      @Stability(Stable) @NotNull public String getAttrPoolId()
      The identifier of the pool.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getWorkspacesPoolRef

      @Stability(Stable) @NotNull public WorkspacesPoolReference getWorkspacesPoolRef()
      A reference to a WorkspacesPool resource.
      Specified by:
      getWorkspacesPoolRef in interface IWorkspacesPoolRef

    • getBundleId

      @Stability(Stable) @NotNull public String getBundleId()
      The identifier of the bundle used by the pool.

    • setBundleId

      @Stability(Stable) public void setBundleId(@NotNull String value)
      The identifier of the bundle used by the pool.

    • getCapacity

      @Stability(Stable) @NotNull public Object getCapacity()
      Describes the user capacity for the pool.

      Returns union: either IResolvable or CfnWorkspacesPool.CapacityProperty

    • setCapacity

      @Stability(Stable) public void setCapacity(@NotNull IResolvable value)
      Describes the user capacity for the pool.

    • setCapacity

      @Stability(Stable) public void setCapacity(@NotNull CfnWorkspacesPool.CapacityProperty value)
      Describes the user capacity for the pool.

    • getDirectoryId

      @Stability(Stable) @NotNull public String getDirectoryId()
      The identifier of the directory used by the pool.

    • setDirectoryId

      @Stability(Stable) public void setDirectoryId(@NotNull String value)
      The identifier of the directory used by the pool.

    • getPoolName

      @Stability(Stable) @NotNull public String getPoolName()
      The name of the pool.

    • setPoolName

      @Stability(Stable) public void setPoolName(@NotNull String value)
      The name of the pool.

    • getApplicationSettings

      @Stability(Stable) @Nullable public Object getApplicationSettings()
      The persistent application settings for users of the pool.

      Returns union: either IResolvable or CfnWorkspacesPool.ApplicationSettingsProperty

    • setApplicationSettings

      @Stability(Stable) public void setApplicationSettings(@Nullable IResolvable value)
      The persistent application settings for users of the pool.

    • setApplicationSettings

      @Stability(Stable) public void setApplicationSettings(@Nullable CfnWorkspacesPool.ApplicationSettingsProperty value)
      The persistent application settings for users of the pool.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the pool.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the pool.

    • getRunningMode

      @Stability(Stable) @Nullable public String getRunningMode()
      The running mode of the pool.

    • setRunningMode

      @Stability(Stable) public void setRunningMode(@Nullable String value)
      The running mode of the pool.

    • getTags

      @Stability(Deprecated) @Deprecated @Nullable public List<CfnTag> getTags()
      Deprecated.
      this property has been deprecated

    • setTags

      @Stability(Deprecated) @Deprecated public void setTags(@Nullable List<CfnTag> value)
      Deprecated.
      this property has been deprecated

    • getTimeoutSettings

      @Stability(Stable) @Nullable public Object getTimeoutSettings()
      The amount of time that a pool session remains active after users disconnect.

      Returns union: either IResolvable or CfnWorkspacesPool.TimeoutSettingsProperty

    • setTimeoutSettings

      @Stability(Stable) public void setTimeoutSettings(@Nullable IResolvable value)
      The amount of time that a pool session remains active after users disconnect.

    • setTimeoutSettings

      @Stability(Stable) public void setTimeoutSettings(@Nullable CfnWorkspacesPool.TimeoutSettingsProperty value)
      The amount of time that a pool session remains active after users disconnect.