interface CfnMicrosoftADMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.DirectoryService.Mixins.CfnMicrosoftADMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdirectoryservice/mixins#CfnMicrosoftADMixinProps
Java	software.amazon.awscdk.mixins.preview.services.directoryservice.mixins.CfnMicrosoftADMixinProps
Python	aws_cdk.mixins_preview.aws_directoryservice.mixins.CfnMicrosoftADMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_directoryservice » mixins » CfnMicrosoftADMixinProps

Properties for CfnMicrosoftADPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as directoryservice_mixins } from '@aws-cdk/mixins-preview/aws-directoryservice';
const cfnMicrosoftADMixinProps: directoryservice_mixins.CfnMicrosoftADMixinProps = {
  createAlias: false,
  edition: 'edition',
  enableSso: false,
  name: 'name',
  password: 'password',
  shortName: 'shortName',
  vpcSettings: {
    subnetIds: ['subnetIds'],
    vpcId: 'vpcId',
  },
};

Properties

Name	Type	Description
createAlias?	boolean | IResolvable	Specifies an alias for a directory and assigns the alias to the directory.
edition?	string	AWS Managed Microsoft AD is available in two editions: Standard and Enterprise .
enableSso?	boolean | IResolvable	Whether to enable single sign-on for a Microsoft Active Directory in AWS .
name?	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?	string	The password for the default administrative user named Admin .
shortName?	string	The NetBIOS name for your domain, such as CORP .
vpcSettings?	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, 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-createalias

---

edition?

Type: string (optional)

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

Enterprise is the default.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-edition

---

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-enablesso

---

name?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-name

---

password?

Type: string (optional)

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 Directory Service API Reference .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-password

---

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-shortname

---

vpcSettings?

Type: IResolvable | VpcSettingsProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-vpcsettings