Skip to content

WorkspaceCreationProperties

Used by
Source code in docs_src/capo_workspaces/types/workspace_creation_properties.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class WorkspaceCreationProperties(TypedDict, closed=True):
    enable_internet_access: NotRequired[
        "capo_workspaces.types.boolean_object.BooleanObject"
    ]
    """<p>Indicates whether internet access is enabled for your WorkSpaces.</p>"""
    default_ou: NotRequired["capo_workspaces.types.default_ou.DefaultOu"]
    """<p>The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form <code>"OU=<i>value</i>,DC=<i>value</i>,DC=<i>value</i>"</code>, where <i>value</i> is any string of characters, and the number of domain components (DCs) is two or more. For example, <code>OU=WorkSpaces_machines,DC=machines,DC=example,DC=com</code>. </p> <important> <ul> <li> <p>To avoid errors, certain characters in the distinguished name must be escaped. For more information, see <a href="https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names"> Distinguished Names</a> in the Microsoft documentation.</p> </li> <li> <p>The API doesn't validate whether the OU exists.</p> </li> </ul> </important>"""
    custom_security_group_id: NotRequired[
        "capo_workspaces.types.security_group_id.SecurityGroupId"
    ]
    """<p>The identifier of your custom security group.</p>"""
    user_enabled_as_local_administrator: NotRequired[
        "capo_workspaces.types.boolean_object.BooleanObject"
    ]
    """<p>Indicates whether users are local administrators of their WorkSpaces.</p>"""
    enable_maintenance_mode: NotRequired[
        "capo_workspaces.types.boolean_object.BooleanObject"
    ]
    """<p>Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html">WorkSpace Maintenance</a>. </p>"""
    instance_iam_role_arn: NotRequired["capo_workspaces.types.arn.ARN"]
    """<p>Indicates the IAM role ARN of the instance.</p>"""

custom_security_group_id instance-attribute 

custom_security_group_id: NotRequired[SecurityGroupId]

The identifier of your custom security group.

default_ou instance-attribute 

default_ou: NotRequired[DefaultOu]

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

  • To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

  • The API doesn't validate whether the OU exists.

enable_internet_access instance-attribute 

enable_internet_access: NotRequired[BooleanObject]

Indicates whether internet access is enabled for your WorkSpaces.

enable_maintenance_mode instance-attribute 

enable_maintenance_mode: NotRequired[BooleanObject]

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

instance_iam_role_arn instance-attribute 

instance_iam_role_arn: NotRequired[ARN]

Indicates the IAM role ARN of the instance.

user_enabled_as_local_administrator instance-attribute 

user_enabled_as_local_administrator: NotRequired[BooleanObject]

Indicates whether users are local administrators of their WorkSpaces.