AWS Fundamentals Logo
AWS Fundamentals
AWS::DirectoryService::SimpleAD

DirectoryService SimpleAD

Resource Type definition for AWS::DirectoryService::SimpleAD

Properties

9 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
Name
string
RequiredCreate-only
Size
string
RequiredCreate-only
VpcSettings
VpcSettings
RequiredCreate-only
CreateAlias
boolean
Create-only
Description
string
Create-only
EnableSso
boolean
Password
string
Create-onlyWrite-only
ShortName
string
Create-only
Tags
Array<Tag>

Return Values

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

AttributeTypeDescription
AliasstringThe alias for a directory.
DirectoryIdstringThe unique identifier for a directory.
DnsIpAddressesArray<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::SimpleAD

Resources:
  MyResource:
    Type: AWS::DirectoryService::SimpleAD
    Properties:
      VpcSettings: "value"
      Size: "value"
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

ds:CreateDirectoryds:CreateAliasds:EnableSsods:DescribeDirectoriesds:AddTagsToResourceds:ListTagsForResourceec2:DescribeSubnetsec2:DescribeVpcs

read

ds:DescribeDirectoriesds:ListTagsForResource

update

ds:EnableSsods:DisableSsods:DescribeDirectoriesds:AddTagsToResourceds:RemoveTagsFromResourceds:ListTagsForResourceec2:CreateTagsec2:DeleteTags

delete

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

list

ds:DescribeDirectories

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

ServiceDirectoryService
Properties12
Required3
TaggingSupported
Primary IDDirectoryId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

SizeVpcSettingsNamePasswordShortNameDescriptionCreateAlias

Related Resources

External Links