aws-native.directoryservice.MicrosoftAd

AWS Cloud Control v1.85.0, Nov 2 26

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Create MicrosoftAd Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MicrosoftAd(name: string, args: MicrosoftAdArgs, opts?: CustomResourceOptions);

@overload
def MicrosoftAd(resource_name: str,
                args: MicrosoftAdArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def MicrosoftAd(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                vpc_settings: Optional[MicrosoftAdVpcSettingsArgs] = None,
                create_alias: Optional[bool] = None,
                edition: Optional[MicrosoftAdEdition] = None,
                enable_sso: Optional[bool] = None,
                name: Optional[str] = None,
                password: Optional[str] = None,
                short_name: Optional[str] = None)

func NewMicrosoftAd(ctx *Context, name string, args MicrosoftAdArgs, opts ...ResourceOption) (*MicrosoftAd, error)

public MicrosoftAd(string name, MicrosoftAdArgs args, CustomResourceOptions? opts = null)

public MicrosoftAd(String name, MicrosoftAdArgs args)
public MicrosoftAd(String name, MicrosoftAdArgs args, CustomResourceOptions options)

type: aws-native:directoryservice:MicrosoftAd
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "aws-native_directoryservice_microsoft_ad" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args MicrosoftAdArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args MicrosoftAdArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MicrosoftAdArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MicrosoftAdArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MicrosoftAdArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

MicrosoftAd Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MicrosoftAd resource accepts the following input properties:

VpcSettings Pulumi.AwsNative.DirectoryService.Inputs.MicrosoftAdVpcSettings: Specifies the VPC settings of the Microsoft AD directory server in AWS.
CreateAlias bool: 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://.awsapps.com. By default, AWS CloudFormation does not create an alias.
Edition Pulumi.AwsNative.DirectoryService.MicrosoftAdEdition: AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
EnableSso bool: 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.
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. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference.
ShortName 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.

VpcSettings MicrosoftAdVpcSettingsArgs: Specifies the VPC settings of the Microsoft AD directory server in AWS.
CreateAlias bool: 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://.awsapps.com. By default, AWS CloudFormation does not create an alias.
Edition MicrosoftAdEdition: AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
EnableSso bool: 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.
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. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference.
ShortName 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.

vpc_settings object: Specifies the VPC settings of the Microsoft AD directory server in AWS.
create_alias bool: 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://.awsapps.com. By default, AWS CloudFormation does not create an alias.
edition "Enterprise" | "Standard": AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
enable_sso bool: 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.
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. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference.
short_name 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.

vpcSettings MicrosoftAdVpcSettings: Specifies the VPC settings of the Microsoft AD directory server in AWS.
createAlias Boolean: 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://.awsapps.com. By default, AWS CloudFormation does not create an alias.
edition MicrosoftAdEdition: AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
enableSso Boolean: 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.
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. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference.
shortName 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.

vpcSettings MicrosoftAdVpcSettings: Specifies the VPC settings of the Microsoft AD directory server in AWS.
createAlias boolean: 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://.awsapps.com. By default, AWS CloudFormation does not create an alias.
edition MicrosoftAdEdition: AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
enableSso boolean: 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.
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. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference.
shortName 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.

vpc_settings MicrosoftAdVpcSettingsArgs: Specifies the VPC settings of the Microsoft AD directory server in AWS.
create_alias bool: 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://.awsapps.com. By default, AWS CloudFormation does not create an alias.
edition MicrosoftAdEdition: AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
enable_sso bool: 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.
name str: 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 str: 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.
short_name str: 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.

vpcSettings Property Map: Specifies the VPC settings of the Microsoft AD directory server in AWS.
createAlias Boolean: 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://.awsapps.com. By default, AWS CloudFormation does not create an alias.
edition "Enterprise" | "Standard": AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
enableSso Boolean: 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.
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. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference.
shortName 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the MicrosoftAd resource produces the following output properties:

Alias string: The alias for a directory
DirectoryId string: Unique identifier for the Microsoft Active Directory
DnsIpAddresses List<string>: The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
Id string: The provider-assigned unique ID for this managed resource.

Alias string: The alias for a directory
DirectoryId string: Unique identifier for the Microsoft Active Directory
DnsIpAddresses []string: The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
Id string: The provider-assigned unique ID for this managed resource.

alias string: The alias for a directory
directory_id string: Unique identifier for the Microsoft Active Directory
dns_ip_addresses list(string): The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
id string: The provider-assigned unique ID for this managed resource.

alias String: The alias for a directory
directoryId String: Unique identifier for the Microsoft Active Directory
dnsIpAddresses List<String>: The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
id String: The provider-assigned unique ID for this managed resource.

alias string: The alias for a directory
directoryId string: Unique identifier for the Microsoft Active Directory
dnsIpAddresses string[]: The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
id string: The provider-assigned unique ID for this managed resource.

alias str: The alias for a directory
directory_id str: Unique identifier for the Microsoft Active Directory
dns_ip_addresses Sequence[str]: The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
id str: The provider-assigned unique ID for this managed resource.

alias String: The alias for a directory
directoryId String: Unique identifier for the Microsoft Active Directory
dnsIpAddresses List<String>: The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

MicrosoftAdEdition, MicrosoftAdEditionArgs

Enterprise: Enterprise
Standard: Standard

MicrosoftAdEditionEnterprise: Enterprise
MicrosoftAdEditionStandard: Standard

"Enterprise": Enterprise
"Standard": Standard

Enterprise: Enterprise
Standard: Standard

Enterprise: Enterprise
Standard: Standard

ENTERPRISE: Enterprise
STANDARD: Standard

"Enterprise": Enterprise
"Standard": Standard

MicrosoftAdVpcSettings, MicrosoftAdVpcSettingsArgs

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation

SubnetIds List<string>: The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
VpcId string: The identifier of the VPC in which to create the directory.

SubnetIds []string: The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
VpcId string: The identifier of the VPC in which to create the directory.

subnet_ids list(string): The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
vpc_id string: The identifier of the VPC in which to create the directory.

subnetIds List<String>: The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
vpcId String: The identifier of the VPC in which to create the directory.

subnetIds string[]: The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
vpcId string: The identifier of the VPC in which to create the directory.

subnet_ids Sequence[str]: The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
vpc_id str: The identifier of the VPC in which to create the directory.

subnetIds List<String>: The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
vpcId String: The identifier of the VPC in which to create the directory.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

aws-native.directoryservice.MicrosoftAd

On this page

On this page

Create MicrosoftAd Resource

Constructor syntax

Parameters

MicrosoftAd Resource Properties

Inputs

Outputs

Supporting Types

MicrosoftAdEdition, MicrosoftAdEditionArgs

MicrosoftAdVpcSettings, MicrosoftAdVpcSettingsArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

aws-native.directoryservice.MicrosoftAd

On this page

On this page

Create MicrosoftAd Resource

Constructor syntax

Parameters

MicrosoftAd Resource Properties

Inputs

Outputs

Supporting Types

MicrosoftAdEdition, MicrosoftAdEditionArgs

MicrosoftAdVpcSettings, MicrosoftAdVpcSettingsArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.