AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DirectoryService::MicrosoftAD

CfnMicrosoftAD

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* .

Import

import { CfnMicrosoftAD } from 'aws-cdk-lib/aws-directoryservice';

Or use the module namespace:

import * as directoryservice from 'aws-cdk-lib/aws-directoryservice';
// directoryservice.CfnMicrosoftAD

Properties

Configuration passed to the constructor as CfnMicrosoftADProps.

nameRequired
string

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.

passwordRequired
string

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* .

vpcSettingsRequired
IResolvable | VpcSettingsProperty

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

createAliasOptional
boolean | IResolvable

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.

editionOptional
string

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

enableSsoOptional
boolean | IResolvable

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.

shortNameOptional
string

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` .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-directoryservice
CFN TypeAWS::DirectoryService::MicrosoftAD
Properties7

Related Constructs

External Links