Documentation

Describes a directory that is used with Amazon WorkSpaces.

See: newWorkspaceDirectory smart constructor.

Create a value of WorkspaceDirectory with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alias:WorkspaceDirectory', workspaceDirectory_alias - The directory alias.

$sel:certificateBasedAuthProperties:WorkspaceDirectory', workspaceDirectory_certificateBasedAuthProperties - The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

$sel:customerUserName:WorkspaceDirectory', workspaceDirectory_customerUserName - The user name for the service account.

$sel:directoryId:WorkspaceDirectory', workspaceDirectory_directoryId - The directory identifier.

$sel:directoryName:WorkspaceDirectory', workspaceDirectory_directoryName - The name of the directory.

$sel:directoryType:WorkspaceDirectory', workspaceDirectory_directoryType - The directory type.

$sel:dnsIpAddresses:WorkspaceDirectory', workspaceDirectory_dnsIpAddresses - The IP addresses of the DNS servers for the directory.

$sel:iamRoleId:WorkspaceDirectory', workspaceDirectory_iamRoleId - 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.

$sel:registrationCode:WorkspaceDirectory', workspaceDirectory_registrationCode - The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

$sel:samlProperties:WorkspaceDirectory', workspaceDirectory_samlProperties - 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.

$sel:selfservicePermissions:WorkspaceDirectory', workspaceDirectory_selfservicePermissions - The default self-service permissions for WorkSpaces in the directory.

$sel:state:WorkspaceDirectory', workspaceDirectory_state - The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED 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 DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.

$sel:subnetIds:WorkspaceDirectory', workspaceDirectory_subnetIds - The identifiers of the subnets used with the directory.

$sel:tenancy:WorkspaceDirectory', workspaceDirectory_tenancy - Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

$sel:workspaceAccessProperties:WorkspaceDirectory', workspaceDirectory_workspaceAccessProperties - The devices and operating systems that users can use to access WorkSpaces.

$sel:workspaceCreationProperties:WorkspaceDirectory', workspaceDirectory_workspaceCreationProperties - The default creation properties for all WorkSpaces in the directory.

$sel:workspaceSecurityGroupId:WorkspaceDirectory', workspaceDirectory_workspaceSecurityGroupId - The identifier of the security group that is assigned to new WorkSpaces.

$sel:ipGroupIds:WorkspaceDirectory', workspaceDirectory_ipGroupIds - The identifiers of the IP access control groups associated with the directory.

The directory alias.

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

The user name for the service account.

The directory identifier.

The name of the directory.

The directory type.

The IP addresses of the DNS servers for the directory.

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.

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

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.

The default self-service permissions for WorkSpaces in the directory.

The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED 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 DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.

The identifiers of the subnets used with the directory.

Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

The devices and operating systems that users can use to access WorkSpaces.

The default creation properties for all WorkSpaces in the directory.

The identifier of the security group that is assigned to new WorkSpaces.

The identifiers of the IP access control groups associated with the directory.