CfnWorkspaceProps

class aws_cdk.aws_workspaces.CfnWorkspaceProps(*, bundle_id, directory_id, user_name, root_volume_encryption_enabled=None, tags=None, user_volume_encryption_enabled=None, volume_encryption_key=None, workspace_properties=None)

Bases: object

Properties for defining a CfnWorkspace.

Parameters:

bundle_id (str) – The identifier of the bundle for the WorkSpace.
directory_id (str) – The identifier of the AWS Directory Service directory for the WorkSpace.
user_name (str) – The user name of the user for the WorkSpace. This user name must exist in the AWS Directory Service directory for the WorkSpace. The reserved keyword, [UNDEFINED] , is used when creating user-decoupled WorkSpaces.
root_volume_encryption_enabled (Union[bool, IResolvable, None]) – Indicates whether the data stored on the root volume is encrypted.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags for the WorkSpace.
user_volume_encryption_enabled (Union[bool, IResolvable, None]) – Indicates whether the data stored on the user volume is encrypted.
volume_encryption_key (Optional[str]) – The ARN of the symmetric AWS KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
workspace_properties (Union[IResolvable, WorkspacePropertiesProperty, Dict[str, Any], None]) – The WorkSpace properties.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.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_workspace_props = workspaces.CfnWorkspaceProps(
    bundle_id="bundleId",
    directory_id="directoryId",
    user_name="userName",

    # the properties below are optional
    root_volume_encryption_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_volume_encryption_enabled=False,
    volume_encryption_key="volumeEncryptionKey",
    workspace_properties=workspaces.CfnWorkspace.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
    )
)