WorkspaceRequest ¶

class WorkspaceRequest(TypedDict, closed=True):
    directory_id: "capo_workspaces.types.directory_id.DirectoryId"
    """<p>The identifier of the Directory Service directory for the WorkSpace. You can use <a>DescribeWorkspaceDirectories</a> to list the available directories.</p>"""
    user_name: "capo_workspaces.types.user_name.UserName"
    """<p>The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.</p> <p>The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.</p> <p>The reserved keyword, <code>[UNDEFINED]</code>, is used when creating user-decoupled WorkSpaces.</p>"""
    bundle_id: "capo_workspaces.types.bundle_id.BundleId"
    """<p>The identifier of the bundle for the WorkSpace. You can use <a>DescribeWorkspaceBundles</a> to list the available bundles.</p>"""
    volume_encryption_key: NotRequired[
        "capo_workspaces.types.volume_encryption_key.VolumeEncryptionKey"
    ]
    """<p>The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.</p>"""
    user_volume_encryption_enabled: NotRequired[
        "capo_workspaces.types.boolean_object.BooleanObject"
    ]
    """<p>Indicates whether the data stored on the user volume is encrypted.</p>"""
    root_volume_encryption_enabled: NotRequired[
        "capo_workspaces.types.boolean_object.BooleanObject"
    ]
    """<p>Indicates whether the data stored on the root volume is encrypted.</p>"""
    workspace_properties: NotRequired[
        "capo_workspaces.types.workspace_properties.WorkspaceProperties"
    ]
    """<p>The WorkSpace properties.</p>"""
    tags: NotRequired["capo_workspaces.types.tag_list.TagList"]
    """<p>The tags for the WorkSpace.</p>"""
    workspace_name: NotRequired["capo_workspaces.types.workspace_name.WorkspaceName"]
    """<p>The name of the user-decoupled WorkSpace.</p> <note> <p> <code>WorkspaceName</code> is required if <code>UserName</code> is <code>[UNDEFINED]</code> for user-decoupled WorkSpaces. <code>WorkspaceName</code> is not applicable if <code>UserName</code> is specified for user-assigned WorkSpaces.</p> </note>"""
    ipv6_address: NotRequired["capo_workspaces.types.ipv6_address.Ipv6Address"]
    """<p>The IPv6 address for the WorkSpace.</p>"""