CfnWorkspacesPoolProps

class aws_cdk.aws_workspaces.CfnWorkspacesPoolProps(*, bundle_id, capacity, directory_id, pool_name, application_settings=None, description=None, running_mode=None, tags=None, timeout_settings=None)

Bases: object

Properties for defining a CfnWorkspacesPool.

Parameters:

  • bundle_id (str) – The identifier of the bundle used by the pool.

  • capacity (Union[IResolvable, CapacityProperty, Dict[str, Any]]) – Describes the user capacity for the pool.

  • directory_id (str) – The identifier of the directory used by the pool.

  • pool_name (str) – The name of the pool.

  • application_settings (Union[IResolvable, ApplicationSettingsProperty, Dict[str, Any], None]) – The persistent application settings for users of the pool.

  • description (Optional[str]) – The description of the pool.

  • running_mode (Optional[str]) – The running mode of the pool.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]])

  • timeout_settings (Union[IResolvable, TimeoutSettingsProperty, Dict[str, Any], None]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# 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
    )
)

Attributes

application_settings

The persistent application settings for users of the pool.

See:

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

bundle_id

The identifier of the bundle used by the pool.

See:

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

capacity

Describes the user capacity for the pool.

See:

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

description

The description of the pool.

See:

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

directory_id

The identifier of the directory used by the pool.

See:

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

pool_name

The name of the pool.

See:

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

running_mode

The running mode of the pool.

See:

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

tags

this property has been deprecated

See:

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

Stability:

deprecated

Type:

deprecated

timeout_settings

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:

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