The `AWS::DirectoryService::MicrosoftAD` resource specifies a Microsoft Active Directory in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials.

For more information, see [AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) in the *Directory Service Admin Guide* .

CfnMicrosoftAD

The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com` . This name will resolve inside your VPC only. It does not need to be publicly resolvable.

name

The password for the default administrative user named `Admin` .

If you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *Directory Service API Reference* .

password

Specifies the VPC settings of the Microsoft AD directory server in AWS .

vpcSettings

Specifies an alias for a directory and assigns the alias to the directory.

The alias is used to construct the access URL for the directory, such as `http://<alias>.awsapps.com` . By default, CloudFormation does not create an alias.

> After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

createAlias

AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .

`Enterprise` is the default.

edition

Whether to enable single sign-on for a Microsoft Active Directory in AWS .

Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. If you don't specify a value, CloudFormation disables single sign-on by default.

enableSso

The NetBIOS name for your domain, such as `CORP` .

If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, `CORP` for the directory DNS `corp.example.com` .

shortName

The `AWS::DirectoryService::SimpleAD` resource specifies an Directory Service Simple Active Directory ( Simple AD ) in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials.

Simple AD is a Microsoft Active Directory–compatible directory. For more information, see [Simple Active Directory](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the *Directory Service Admin Guide* .

CfnSimpleAD

The fully qualified name for the directory, such as `corp.example.com` .

The size of the directory.

For valid values, see [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the *Directory Service API Reference* .

size

A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.

If set to `true` , specifies an alias for a directory and assigns the alias to the directory.

The alias is used to construct the access URL for the directory, such as `http://<alias>.awsapps.com` . By default, this property is set to `false` .

> After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

description

Whether to enable single sign-on for a directory.

If you don't specify a value, CloudFormation disables single sign-on by default.

The password for the directory administrator.

The directory creation process creates a directory administrator account with the user name `Administrator` and this password.

If you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *Directory Service API Reference* .

The NetBIOS name of the directory, such as `CORP` .

AWS directoryservice

L1 Constructs2

CfnMicrosoftAD

CfnSimpleAD

Learn AWS the Practical Way

Quick Facts

Related Links

More AWS directoryservice deep dives