WorkspaceDirectory

Information about the Active Directory config.

Type: ActiveDirectoryConfig object

Required: No

The directory alias.

Type: String

Required: No

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

Type: CertificateBasedAuthProperties object

Required: No

The user name for the service account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: No

The directory identifier.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)

Required: No

The name of the directory.

Type: String

Required: No

The directory type.

Type: String

Valid Values: SIMPLE_AD | AD_CONNECTOR | CUSTOMER_MANAGED | AWS_IAM_IDENTITY_CENTER

Required: No

The IP addresses of the DNS servers for the directory.

Type: Array of strings

Required: No

The error message returned.

Type: String

Required: No

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.

Type: String

Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Required: No

Specifies details about identity center configurations.

Type: IDCConfig object

Required: No

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

Type: Array of strings

Pattern: wsipg-[0-9a-z]{8,63}$

Required: No

Specifies details about Microsoft Entra configurations.

Type: MicrosoftEntraConfig object

Required: No

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Required: No

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.

Type: SamlProperties object

Required: No

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

Type: SelfservicePermissions object

Required: No

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.

Type: String

Valid Values: REGISTERING | REGISTERED | DEREGISTERING | DEREGISTERED | ERROR

Required: No

The streaming properties to configure.

Type: StreamingProperties object

Required: No

The identifiers of the subnets used with the directory.

Type: Array of strings

Array Members: Maximum number of 2 items.

Length Constraints: Minimum length of 15. Maximum length of 24.

Pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$

Required: No

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.

Type: String

Valid Values: DEDICATED | SHARED

Required: No

Indicates the identity type of the specifired user.

Type: String

Valid Values: CUSTOMER_MANAGED | AWS_DIRECTORY_SERVICE | AWS_IAM_IDENTITY_CENTER

Required: No

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

Type: WorkspaceAccessProperties object

Required: No

The default creation properties for all WorkSpaces in the directory.

Type: DefaultWorkspaceCreationProperties object

Required: No

The description of the WorkSpace directory

Type: String

Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]{1,255}$

Required: No

The name fo the WorkSpace directory.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.\s-]{1,64}$

Required: No

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

Type: String

Length Constraints: Minimum length of 11. Maximum length of 20.

Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$

Required: No

Indicates whether the directory's WorkSpace type is personal or pools.

Type: String

Valid Values: PERSONAL | POOLS

Required: No