CfnWorkspacesPoolPropsMixin

class aws_cdk.mixins_preview.aws_workspaces.mixins.CfnWorkspacesPoolPropsMixin(props, *, strategy=None)

Bases: Mixin

Describes a pool of WorkSpaces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspacespool.html
CloudformationResource:: AWS::WorkSpaces::WorkspacesPool
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_workspaces import mixins as workspaces_mixins

cfn_workspaces_pool_props_mixin = workspaces_mixins.CfnWorkspacesPoolPropsMixin(workspaces_mixins.CfnWorkspacesPoolMixinProps(
    application_settings=workspaces_mixins.CfnWorkspacesPoolPropsMixin.ApplicationSettingsProperty(
        settings_group="settingsGroup",
        status="status"
    ),
    bundle_id="bundleId",
    capacity=workspaces_mixins.CfnWorkspacesPoolPropsMixin.CapacityProperty(
        desired_user_sessions=123
    ),
    description="description",
    directory_id="directoryId",
    pool_name="poolName",
    running_mode="runningMode",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout_settings=workspaces_mixins.CfnWorkspacesPoolPropsMixin.TimeoutSettingsProperty(
        disconnect_timeout_in_seconds=123,
        idle_disconnect_timeout_in_seconds=123,
        max_user_duration_in_seconds=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::WorkSpaces::WorkspacesPool.

Parameters:

props (Union[CfnWorkspacesPoolMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationSettings', 'bundleId', 'capacity', 'description', 'directoryId', 'poolName', 'runningMode', 'tags', 'timeoutSettings']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ApplicationSettingsProperty

class CfnWorkspacesPoolPropsMixin.ApplicationSettingsProperty(*, settings_group=None, status=None)

Bases: object

The persistent application settings for users in the pool.

Parameters:

settings_group (Optional[str]) – The path prefix for the S3 bucket where users’ persistent application settings are stored.
status (Optional[str]) – Enables or disables persistent application settings for users during their pool sessions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspacespool-applicationsettings.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.mixins_preview.aws_workspaces import mixins as workspaces_mixins

application_settings_property = workspaces_mixins.CfnWorkspacesPoolPropsMixin.ApplicationSettingsProperty(
    settings_group="settingsGroup",
    status="status"
)

Attributes

settings_group

The path prefix for the S3 bucket where users’ persistent application settings are stored.

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

status

Enables or disables persistent application settings for users during their pool sessions.

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

CapacityProperty

class CfnWorkspacesPoolPropsMixin.CapacityProperty(*, desired_user_sessions=None)

Bases: object

Describes the user capacity for the pool.

Parameters:: desired_user_sessions (Union[int, float, None]) – The desired number of user sessions for the WorkSpaces in the pool.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspacespool-capacity.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.mixins_preview.aws_workspaces import mixins as workspaces_mixins

capacity_property = workspaces_mixins.CfnWorkspacesPoolPropsMixin.CapacityProperty(
    desired_user_sessions=123
)

Attributes

desired_user_sessions

The desired number of user sessions for the WorkSpaces in the pool.

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

TimeoutSettingsProperty

class CfnWorkspacesPoolPropsMixin.TimeoutSettingsProperty(*, disconnect_timeout_in_seconds=None, idle_disconnect_timeout_in_seconds=None, max_user_duration_in_seconds=None)

Bases: object

Describes the timeout settings for the pool.

Parameters:

disconnect_timeout_in_seconds (Union[int, float, None]) – Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
idle_disconnect_timeout_in_seconds (Union[int, float, None]) – The amount of time in seconds a connection will stay active while idle.
max_user_duration_in_seconds (Union[int, float, None]) – Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspacespool-timeoutsettings.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.mixins_preview.aws_workspaces import mixins as workspaces_mixins

timeout_settings_property = workspaces_mixins.CfnWorkspacesPoolPropsMixin.TimeoutSettingsProperty(
    disconnect_timeout_in_seconds=123,
    idle_disconnect_timeout_in_seconds=123,
    max_user_duration_in_seconds=123
)

Attributes

disconnect_timeout_in_seconds

Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect.

If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

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

idle_disconnect_timeout_in_seconds

The amount of time in seconds a connection will stay active while idle.

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

max_user_duration_in_seconds

Specifies the maximum amount of time, in seconds, that a streaming session can remain active.

If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

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