CfnWorkspacePropsMixin

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

Bases: Mixin

The AWS::WorkSpaces::Workspace resource specifies a WorkSpace.

Updates are not supported for the BundleId , RootVolumeEncryptionEnabled , UserVolumeEncryptionEnabled , or VolumeEncryptionKey properties. To update these properties, you must also update a property that triggers a replacement, such as the UserName property.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html
CloudformationResource:: AWS::WorkSpaces::Workspace
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_workspace_props_mixin = workspaces_mixins.CfnWorkspacePropsMixin(workspaces_mixins.CfnWorkspaceMixinProps(
    bundle_id="bundleId",
    directory_id="directoryId",
    root_volume_encryption_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_name="userName",
    user_volume_encryption_enabled=False,
    volume_encryption_key="volumeEncryptionKey",
    workspace_properties=workspaces_mixins.CfnWorkspacePropsMixin.WorkspacePropertiesProperty(
        compute_type_name="computeTypeName",
        root_volume_size_gib=123,
        running_mode="runningMode",
        running_mode_auto_stop_timeout_in_minutes=123,
        user_volume_size_gib=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnWorkspaceMixinProps, 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 = ['bundleId', 'directoryId', 'rootVolumeEncryptionEnabled', 'tags', 'userName', 'userVolumeEncryptionEnabled', 'volumeEncryptionKey', 'workspaceProperties']

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

WorkspacePropertiesProperty

class CfnWorkspacePropsMixin.WorkspacePropertiesProperty(*, compute_type_name=None, root_volume_size_gib=None, running_mode=None, running_mode_auto_stop_timeout_in_minutes=None, user_volume_size_gib=None)

Bases: object

Information about a WorkSpace.

Parameters:

compute_type_name (Optional[str]) – The compute type. For more information, see Amazon WorkSpaces Bundles .
root_volume_size_gib (Union[int, float, None]) – The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
running_mode (Optional[str]) – The running mode. For more information, see Manage the WorkSpace Running Mode .
running_mode_auto_stop_timeout_in_minutes (Union[int, float, None]) – The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
user_volume_size_gib (Union[int, float, None]) –
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.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

workspace_properties_property = workspaces_mixins.CfnWorkspacePropsMixin.WorkspacePropertiesProperty(
    compute_type_name="computeTypeName",
    root_volume_size_gib=123,
    running_mode="runningMode",
    running_mode_auto_stop_timeout_in_minutes=123,
    user_volume_size_gib=123
)