AWS::DirectoryService::MicrosoftAD

DirectoryService MicrosoftAD

Resource Type definition for AWS::DirectoryService::MicrosoftAD

Properties

7 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	RequiredCreate-only
`VpcSettings`	`VpcSettings`	RequiredCreate-only
`CreateAlias`	`boolean`	Create-only
`Edition`	`string`	Create-only
`EnableSso`	`boolean`
`Password`	`string`	Create-onlyWrite-only
`ShortName`	`string`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Alias`	`string`	The alias for a directory
`DirectoryId`	`string`	Unique identifier for the Microsoft Active Directory
`DnsIpAddresses`	`Array<string>`	The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ].

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DirectoryService::MicrosoftAD

Resources:
  MyResource:
    Type: AWS::DirectoryService::MicrosoftAD
    Properties:
      VpcSettings: "value"
      Name: "my-name"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ds:CreateAliasds:CreateMicrosoftADds:EnableSsods:DisableSsods:DescribeDirectoriesec2:DescribeSubnetsec2:DescribeVpcsec2:CreateSecurityGroupec2:CreateNetworkInterfaceec2:DescribeNetworkInterfacesec2:AuthorizeSecurityGroupIngressec2:AuthorizeSecurityGroupEgressec2:CreateTagsec2:RevokeSecurityGroupEgressec2:RevokeSecurityGroupIngress

read

ds:DescribeDirectories

update

ds:EnableSsods:DisableSsods:CheckStabilizationForSsods:DescribeDirectories

delete

ds:DeleteDirectoryds:CheckStabilizationForDeleteds:DescribeDirectoriesec2:DescribeNetworkInterfacesec2:DeleteSecurityGroupec2:DeleteNetworkInterfaceec2:RevokeSecurityGroupIngressec2:RevokeSecurityGroupEgressec2:DeleteTags