This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::DirectoryService::SimpleAD
<a name="aws-resource-directoryservice-simplead"></a>

The `AWS::DirectoryService::SimpleAD` resource specifies an Directory Service Simple Active Directory (Simple AD) in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. Simple AD is a Microsoft Active Directory–compatible directory. For more information, see [Simple Active Directory](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the *Directory Service Admin Guide*.

## Syntax
<a name="aws-resource-directoryservice-simplead-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-directoryservice-simplead-syntax.json"></a>

```
{
  "Type" : "AWS::DirectoryService::SimpleAD",
  "Properties" : {
      "[CreateAlias](#cfn-directoryservice-simplead-createalias)" : Boolean,
      "[Description](#cfn-directoryservice-simplead-description)" : String,
      "[EnableSso](#cfn-directoryservice-simplead-enablesso)" : Boolean,
      "[Name](#cfn-directoryservice-simplead-name)" : String,
      "[Password](#cfn-directoryservice-simplead-password)" : String,
      "[ShortName](#cfn-directoryservice-simplead-shortname)" : String,
      "[Size](#cfn-directoryservice-simplead-size)" : String,
      "[Tags](#cfn-directoryservice-simplead-tags)" : [ Tag, ... ],
      "[VpcSettings](#cfn-directoryservice-simplead-vpcsettings)" : VpcSettings
    }
}
```

### YAML
<a name="aws-resource-directoryservice-simplead-syntax.yaml"></a>

```
Type: AWS::DirectoryService::SimpleAD
Properties:
  [CreateAlias](#cfn-directoryservice-simplead-createalias): Boolean
  [Description](#cfn-directoryservice-simplead-description): String
  [EnableSso](#cfn-directoryservice-simplead-enablesso): Boolean
  [Name](#cfn-directoryservice-simplead-name): String
  [Password](#cfn-directoryservice-simplead-password): String
  [ShortName](#cfn-directoryservice-simplead-shortname): String
  [Size](#cfn-directoryservice-simplead-size): String
  [Tags](#cfn-directoryservice-simplead-tags): 
    - Tag
  [VpcSettings](#cfn-directoryservice-simplead-vpcsettings): 
    VpcSettings
```

## Properties
<a name="aws-resource-directoryservice-simplead-properties"></a>

`CreateAlias`  <a name="cfn-directoryservice-simplead-createalias"></a>
If set to `true`, 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, this property is set to `false`.  
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Description`  <a name="cfn-directoryservice-simplead-description"></a>
A description for the directory.  
*Required*: No  
*Type*: String  
*Pattern*: `^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$`  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EnableSso`  <a name="cfn-directoryservice-simplead-enablesso"></a>
Whether to enable single sign-on for a directory. If you don't specify a value, CloudFormation disables single sign-on by default.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-directoryservice-simplead-name"></a>
The fully qualified name for the directory, such as `corp.example.com`.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Password`  <a name="cfn-directoryservice-simplead-password"></a>
The password for the directory administrator. The directory creation process creates a directory administrator account with the user name `Administrator` and this password.  
If you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *Directory Service API Reference*.  
*Required*: No  
*Type*: String  
*Pattern*: `(?=^.{8,64}$)((?=.*\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s]))^.*`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ShortName`  <a name="cfn-directoryservice-simplead-shortname"></a>
The NetBIOS name of the directory, such as `CORP`.  
*Required*: No  
*Type*: String  
*Pattern*: `^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Size`  <a name="cfn-directoryservice-simplead-size"></a>
The size of the directory. For valid values, see [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the *Directory Service API Reference*.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Small | Large`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-directoryservice-simplead-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-directoryservice-simplead-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcSettings`  <a name="cfn-directoryservice-simplead-vpcsettings"></a>
A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.  
*Required*: Yes  
*Type*: [VpcSettings](aws-properties-directoryservice-simplead-vpcsettings.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-directoryservice-simplead-return-values"></a>

### Ref
<a name="aws-resource-directoryservice-simplead-return-values-ref"></a>

When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the resource ID.

In the following sample, the `Ref` function returns the ID of the `myDirectory` directory, such as `d-1a2b3c4d5e`.

 `{ "Ref": "myDirectory" }` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-directoryservice-simplead-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-directoryservice-simplead-return-values-fn--getatt-fn--getatt"></a>

`Alias`  <a name="Alias-fn::getatt"></a>
The alias for a directory. For example: `alias4-mydirectory-12345abcgmzsk` (if you have the `CreateAlias` property set to true).

`DirectoryId`  <a name="DirectoryId-fn::getatt"></a>
The directory ID. For example: `d-12373a053a`.

`DnsIpAddresses`  <a name="DnsIpAddresses-fn::getatt"></a>
The IP addresses of the DNS servers for the directory, such as `[ "172.31.3.154", "172.31.63.203" ]`.

## Examples
<a name="aws-resource-directoryservice-simplead--examples"></a>

The following example creates a Simple AD directory, where the directory DNS name is `corp.example.com`:

### Create a Simple AD Directory
<a name="aws-resource-directoryservice-simplead--examples--Create_a_Directory"></a>

#### JSON
<a name="aws-resource-directoryservice-simplead--examples--Create_a_Directory--json"></a>

```
"myDirectory" : {
  "Type" : "AWS::DirectoryService::SimpleAD",
  "Properties" : {
    "Name" : "corp.example.com",
    "Password" : { "Ref" : "SimpleADPW" },
    "Size" : "Small",
    "VpcSettings" : { 
      "SubnetIds" : [ { "Ref" : "subnetID1" }, { "Ref" : "subnetID2" } ],
      "VpcId" : { "Ref" : "vpcID" }
    }
  }
}
```

#### YAML
<a name="aws-resource-directoryservice-simplead--examples--Create_a_Directory--yaml"></a>

```
myDirectory: 
  Type: AWS::DirectoryService::SimpleAD
  Properties: 
    Name: "corp.example.com"
    Password: 
      Ref: SimpleADPW
    Size: "Small"
    VpcSettings: 
      SubnetIds: 
        - Ref: subnetID1
        - Ref: subnetID2
      VpcId: 
        Ref: vpcID
```

## See also
<a name="aws-resource-directoryservice-simplead--seealso"></a>
+ [Getting Started with Simple AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/simple_ad_getting_started.html) in the *Directory Service Admin Guide*..
+ [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the *Directory Service API Reference*.



# AWS::DirectoryService::SimpleAD Tag
<a name="aws-properties-directoryservice-simplead-tag"></a>

Metadata assigned to a directory consisting of a key-value pair.

## Syntax
<a name="aws-properties-directoryservice-simplead-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-directoryservice-simplead-tag-syntax.json"></a>

```
{
  "[Key](#cfn-directoryservice-simplead-tag-key)" : String,
  "[Value](#cfn-directoryservice-simplead-tag-value)" : String
}
```

### YAML
<a name="aws-properties-directoryservice-simplead-tag-syntax.yaml"></a>

```
  [Key](#cfn-directoryservice-simplead-tag-key): String
  [Value](#cfn-directoryservice-simplead-tag-value): String
```

## Properties
<a name="aws-properties-directoryservice-simplead-tag-properties"></a>

`Key`  <a name="cfn-directoryservice-simplead-tag-key"></a>
Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-', ':', '@'(Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-directoryservice-simplead-tag-value"></a>
The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-', ':', '@' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::DirectoryService::SimpleAD VpcSettings
<a name="aws-properties-directoryservice-simplead-vpcsettings"></a>

Contains VPC information for the [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) or [CreateMicrosoftAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html) operation.

## Syntax
<a name="aws-properties-directoryservice-simplead-vpcsettings-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-directoryservice-simplead-vpcsettings-syntax.json"></a>

```
{
  "[SubnetIds](#cfn-directoryservice-simplead-vpcsettings-subnetids)" : [ String, ... ],
  "[VpcId](#cfn-directoryservice-simplead-vpcsettings-vpcid)" : String
}
```

### YAML
<a name="aws-properties-directoryservice-simplead-vpcsettings-syntax.yaml"></a>

```
  [SubnetIds](#cfn-directoryservice-simplead-vpcsettings-subnetids): 
    - String
  [VpcId](#cfn-directoryservice-simplead-vpcsettings-vpcid): String
```

## Properties
<a name="aws-properties-directoryservice-simplead-vpcsettings-properties"></a>

`SubnetIds`  <a name="cfn-directoryservice-simplead-vpcsettings-subnetids"></a>
The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. Directory Service specifies a directory server and a DNS server in each of these subnets.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VpcId`  <a name="cfn-directoryservice-simplead-vpcsettings-vpcid"></a>
The identifier of the VPC in which to create the directory.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)