WorkSpaces Directory

Docs > DDSQL Reference > Data Directory > WorkSpaces Directory

WorkSpaces Directory in AWS is a registered directory that enables the use of Amazon WorkSpaces. It acts as the authentication and management backbone, allowing users to log in with their existing credentials. The directory can be an AWS Managed Microsoft AD, Simple AD, or an AD Connector to an on-premises Active Directory. It manages user access, policies, and integration with corporate identity systems, ensuring secure and seamless access to virtual desktops.

aws.workspaces_directory

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
active_directory_config	core	json	Information about the Active Directory config.
alias	core	string	The directory alias.
certificate_based_auth_properties	core	json	The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
customer_user_name	core	string	The user name for the service account.
directory_id	core	string	The directory identifier.
directory_name	core	string	The name of the directory.
directory_type	core	string	The directory type.
dns_ip_addresses	core	array<string>	The IP addresses of the DNS servers for the directory.
error_message	core	string	The error message returned.
iam_role_id	core	string	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.
idc_config	core	json	Specifies details about identity center configurations.
ip_group_ids	core	array<string>	The identifiers of the IP access control groups associated with the directory.
microsoft_entra_config	core	json	Specifies details about Microsoft Entra configurations.
registration_code	core	string	The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
saml_properties	core	json	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.
selfservice_permissions	core	json	The default self-service permissions for WorkSpaces in the directory.
state	core	string	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.
streaming_properties	core	json	The streaming properties to configure.
subnet_ids	core	array<string>	The identifiers of the subnets used with the directory.
tags	core	hstore
tenancy	core	string	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.
user_identity_type	core	string	Indicates the identity type of the specifired user.
workspace_access_properties	core	json	The devices and operating systems that users can use to access WorkSpaces.
workspace_creation_properties	core	json	The default creation properties for all WorkSpaces in the directory.
workspace_directory_description	core	string	The description of the WorkSpace directory
workspace_directory_name	core	string	The name fo the WorkSpace directory.
workspace_security_group_id	core	string	The identifier of the security group that is assigned to new WorkSpaces.
workspace_type	core	string	Indicates whether the directory's WorkSpace type is personal or pools.