aws-cdk-lib.aws_directoryservice.CfnMicrosoftADProps

interface CfnMicrosoftADProps

LanguageType name
.NETAmazon.CDK.AWS.DirectoryService.CfnMicrosoftADProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdirectoryservice#CfnMicrosoftADProps
Javasoftware.amazon.awscdk.services.directoryservice.CfnMicrosoftADProps
Pythonaws_cdk.aws_directoryservice.CfnMicrosoftADProps
TypeScript aws-cdk-lib » aws_directoryservice » CfnMicrosoftADProps

Properties for defining a CfnMicrosoftAD.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_directoryservice as directoryservice } from 'aws-cdk-lib';
const cfnMicrosoftADProps: directoryservice.CfnMicrosoftADProps = {
  name: 'name',
  password: 'password',
  vpcSettings: {
    subnetIds: ['subnetIds'],
    vpcId: 'vpcId',
  },

  // the properties below are optional
  createAlias: false,
  edition: 'edition',
  enableSso: false,
  shortName: 'shortName',
};

Properties

NameTypeDescription
namestringThe 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.
passwordstringThe password for the default administrative user named Admin .
vpcSettingsIResolvable | VpcSettingsPropertySpecifies the VPC settings of the Microsoft AD directory server in AWS .
createAlias?boolean | IResolvableSpecifies an alias for a directory and assigns the alias to the directory.
edition?stringAWS Managed Microsoft AD is available in two editions: Standard and Enterprise .
enableSso?boolean | IResolvableWhether to enable single sign-on for a Microsoft Active Directory in AWS .
shortName?stringThe NetBIOS name for your domain, such as CORP .

name

Type: 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.


password

Type: string

The password for the default administrative user named Admin .

If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .


vpcSettings

Type: IResolvable | VpcSettingsProperty

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


createAlias?

Type: boolean | IResolvable (optional)

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, AWS 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.


edition?

Type: string (optional)

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

Enterprise is the default.


enableSso?

Type: boolean | IResolvable (optional)

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, AWS CloudFormation disables single sign-on by default.


shortName?

Type: string (optional)

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 .