WorkspaceDirectory ¶

class WorkspaceDirectory(TypedDict, closed=True):
    directory_id: NotRequired["capo_workspaces.types.directory_id.DirectoryId"]
    """<p>The directory identifier.</p>"""
    alias: NotRequired["capo_workspaces.types.alias.Alias"]
    """<p>The directory alias.</p>"""
    directory_name: NotRequired["capo_workspaces.types.directory_name.DirectoryName"]
    """<p>The name of the directory.</p>"""
    registration_code: NotRequired[
        "capo_workspaces.types.registration_code.RegistrationCode"
    ]
    """<p>The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.</p>"""
    subnet_ids: NotRequired["capo_workspaces.types.subnet_ids.SubnetIds"]
    """<p>The identifiers of the subnets used with the directory.</p>"""
    dns_ip_addresses: NotRequired[
        "capo_workspaces.types.dns_ip_addresses.DnsIpAddresses"
    ]
    """<p>The IP addresses of the DNS servers for the directory.</p>"""
    dns_ipv6_addresses: NotRequired[
        "capo_workspaces.types.dns_ipv6_addresses.DnsIpv6Addresses"
    ]
    """<p>The IPv6 addresses of the DNS servers for the directory.</p>"""
    customer_user_name: NotRequired["capo_workspaces.types.user_name.UserName"]
    """<p>The user name for the service account.</p>"""
    iam_role_id: NotRequired["capo_workspaces.types.arn.ARN"]
    """<p>The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.</p>"""
    directory_type: NotRequired[
        "capo_workspaces.types.workspace_directory_type.WorkspaceDirectoryType"
    ]
    """<p>The directory type.</p>"""
    workspace_security_group_id: NotRequired[
        "capo_workspaces.types.security_group_id.SecurityGroupId"
    ]
    """<p>The identifier of the security group that is assigned to new WorkSpaces.</p>"""
    state: NotRequired[
        "capo_workspaces.types.workspace_directory_state.WorkspaceDirectoryState"
    ]
    """<p>The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the <code>DEREGISTERED</code> state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html"> DescribeWorkspaceDirectories</a>. If the directory ID isn't returned, then the directory has been successfully deregistered.</p>"""
    workspace_creation_properties: NotRequired[
        "capo_workspaces.types.default_workspace_creation_properties.DefaultWorkspaceCreationProperties"
    ]
    """<p>The default creation properties for all WorkSpaces in the directory.</p>"""
    ip_group_ids: NotRequired["capo_workspaces.types.ip_group_id_list.IpGroupIdList"]
    """<p>The identifiers of the IP access control groups associated with the directory.</p>"""
    workspace_access_properties: NotRequired[
        "capo_workspaces.types.workspace_access_properties.WorkspaceAccessProperties"
    ]
    """<p>The devices and operating systems that users can use to access WorkSpaces.</p>"""
    tenancy: NotRequired["capo_workspaces.types.tenancy.Tenancy"]
    """<p>Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to <code>DEDICATED</code>. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html">Bring Your Own Windows Desktop Images</a>.</p>"""
    selfservice_permissions: NotRequired[
        "capo_workspaces.types.selfservice_permissions.SelfservicePermissions"
    ]
    """<p>The default self-service permissions for WorkSpaces in the directory.</p>"""
    saml_properties: NotRequired["capo_workspaces.types.saml_properties.SamlProperties"]
    """<p>Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.</p>"""
    certificate_based_auth_properties: NotRequired[
        "capo_workspaces.types.certificate_based_auth_properties.CertificateBasedAuthProperties"
    ]
    """<p>The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.</p>"""
    endpoint_encryption_mode: NotRequired[
        "capo_workspaces.types.endpoint_encryption_mode.EndpointEncryptionMode"
    ]
    """<p>Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.</p>"""
    microsoft_entra_config: NotRequired[
        "capo_workspaces.types.microsoft_entra_config.MicrosoftEntraConfig"
    ]
    """<p>Specifies details about Microsoft Entra configurations.</p>"""
    workspace_directory_name: NotRequired[
        "capo_workspaces.types.workspace_directory_name.WorkspaceDirectoryName"
    ]
    """<p>The name fo the WorkSpace directory.</p>"""
    workspace_directory_description: NotRequired[
        "capo_workspaces.types.workspace_directory_description.WorkspaceDirectoryDescription"
    ]
    """<p>The description of the WorkSpace directory</p>"""
    user_identity_type: NotRequired[
        "capo_workspaces.types.user_identity_type.UserIdentityType"
    ]
    """<p>Indicates the identity type of the specifired user.</p>"""
    workspace_type: NotRequired["capo_workspaces.types.workspace_type.WorkspaceType"]
    """<p>Indicates whether the directory's WorkSpace type is personal or pools.</p>"""
    idc_config: NotRequired["capo_workspaces.types.idc_config.IDCConfig"]
    """<p>Specifies details about identity center configurations.</p>"""
    active_directory_config: NotRequired[
        "capo_workspaces.types.active_directory_config.ActiveDirectoryConfig"
    ]
    """<p>Information about the Active Directory config.</p>"""
    streaming_properties: NotRequired[
        "capo_workspaces.types.streaming_properties.StreamingProperties"
    ]
    """<p>The streaming properties to configure.</p>"""
    error_message: NotRequired["capo_workspaces.types.description.Description"]
    """<p>The error message returned.</p>"""