Skip to content
v2.277.0

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,
  },
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspaces as workspaces

cfn_workspaces_pool_props = workspaces.CfnWorkspacesPoolProps(
    bundle_id="bundleId",
    capacity=workspaces.CfnWorkspacesPool.CapacityProperty(
        desired_user_sessions=123
    ),
    directory_id="directoryId",
    pool_name="poolName",

    # the properties below are optional
    application_settings=workspaces.CfnWorkspacesPool.ApplicationSettingsProperty(
        status="status",

        # the properties below are optional
        settings_group="settingsGroup"
    ),
    description="description",
    running_mode="runningMode",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout_settings=workspaces.CfnWorkspacesPool.TimeoutSettingsProperty(
        disconnect_timeout_in_seconds=123,
        idle_disconnect_timeout_in_seconds=123,
        max_user_duration_in_seconds=123
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpaces;

var cfnWorkspacesPoolProps = new CfnWorkspacesPoolProps {
    BundleId = "bundleId",
    Capacity = new CapacityProperty {
        DesiredUserSessions = 123
    },
    DirectoryId = "directoryId",
    PoolName = "poolName",

    // the properties below are optional
    ApplicationSettings = new ApplicationSettingsProperty {
        Status = "status",

        // the properties below are optional
        SettingsGroup = "settingsGroup"
    },
    Description = "description",
    RunningMode = "runningMode",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TimeoutSettings = new TimeoutSettingsProperty {
        DisconnectTimeoutInSeconds = 123,
        IdleDisconnectTimeoutInSeconds = 123,
        MaxUserDurationInSeconds = 123
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnWorkspacesPoolProps := &CfnWorkspacesPoolProps{
	BundleId: jsii.String("bundleId"),
	Capacity: &CapacityProperty{
		DesiredUserSessions: jsii.Number(123),
	},
	DirectoryId: jsii.String("directoryId"),
	PoolName: jsii.String("poolName"),

	// the properties below are optional
	ApplicationSettings: &ApplicationSettingsProperty{
		Status: jsii.String("status"),

		// the properties below are optional
		SettingsGroup: jsii.String("settingsGroup"),
	},
	Description: jsii.String("description"),
	RunningMode: jsii.String("runningMode"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TimeoutSettings: &TimeoutSettingsProperty{
		DisconnectTimeoutInSeconds: jsii.Number(123),
		IdleDisconnectTimeoutInSeconds: jsii.Number(123),
		MaxUserDurationInSeconds: jsii.Number(123),
	},
}

Properties ​

applicationSettingsoptionalIResolvable | CfnWorkspacesPool.ApplicationSettingsPropertyapplication_settingsoptionaltyping.Union[IResolvable, ApplicationSettingsProperty]applicationSettingsoptionalIResolvableApplicationSettingsoptionalIResolvableApplicationSettingsoptionalinterface{} #
The persistent application settings for users of the pool.
bundleIdstringbundle_idstrbundleIdStringBundleIdstringBundleId*string required #
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.
directoryIdstringdirectory_idstrdirectoryIdStringDirectoryIdstringDirectoryId*string required #
The identifier of the directory used by the pool.
poolNamestringpool_namestrpoolNameStringPoolNamestringPoolName*string required #
The name of the pool.
runningModeoptionalstringrunning_modeoptionalstrrunningModeoptionalStringRunningModeoptionalstringRunningModeoptional*string #
The running mode of the pool.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag deprecated #
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.