DirectoryDescription

The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.

Type: String

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

Required: No

The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

Type: String

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

Pattern: ^(?!D-|d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*

Required: No

A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.

Type: DirectoryConnectSettingsDescription object

Required: No

The description for the directory.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

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

Required: No

The desired number of domain controllers in the directory if the directory is Microsoft AD.

Type: Integer

Valid Range: Minimum value of 2.

Required: No

The directory identifier.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: No

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in your self-managed directory to which the AD Connector is connected.

Type: Array of strings

Pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$

Required: No

The edition associated with this directory.

Type: String

Valid Values: Enterprise | Standard

Required: No

Specifies when the directory was created.

Type: Timestamp

Required: No

The fully qualified name of the directory.

Type: String

Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$

Required: No

The operating system (OS) version of the directory.

Type: String

Valid Values: SERVER_2012 | SERVER_2019

Required: No

Describes the AWS Managed Microsoft AD directory in the directory owner account.

Type: OwnerDirectoryDescription object

Required: No

A RadiusSettings object that contains information about the RADIUS server configured for this directory.

Type: RadiusSettings object

Required: No

The status of the RADIUS MFA server connection.

Type: String

Valid Values: Creating | Completed | Failed

Required: No

Lists the Regions where the directory has replicated.

Type: RegionsInfo object

Required: No

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE).

Type: String

Valid Values: ORGANIZATIONS | HANDSHAKE

Required: No

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

Current directory status of the shared AWS Managed Microsoft AD directory.

Type: String

Valid Values: Shared | PendingAcceptance | Rejected | Rejecting | RejectFailed | Sharing | ShareFailed | Deleted | Deleting

Required: No

The short name of the directory.

Type: String

Pattern: ^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$

Required: No

The directory size.

Type: String

Valid Values: Small | Large

Required: No

Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.

Type: Boolean

Required: No

The current stage of the directory.

Type: String

Valid Values: Requested | Creating | Created | Active | Inoperable | Impaired | Restoring | RestoreFailed | Deleting | Deleted | Failed | Updating

Required: No

The date and time that the stage was last updated.

Type: Timestamp

Required: No

Additional information about the directory stage.

Type: String

Required: No

The directory type.

Type: String

Valid Values: SimpleAD | ADConnector | MicrosoftAD | SharedMicrosoftAD

Required: No

A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or AWS Managed Microsoft AD directory.

Type: DirectoryVpcSettingsDescription object

Required: No