AWS CloudFormation
用户指南 (API 版本 2010-05-15)

AWS::DirectoryService::SimpleAD

AWS::DirectoryService::SimpleAD 资源在 AWS 中创建一个 AWS Directory Service Simple Active Directory (Simple AD),以便您的目录用户和组能够使用其现有凭证访问 AWS 管理控制台 和 AWS 应用程序。Simple AD 是一种兼容 Microsoft Active Directory 的目录。有关更多信息,请参阅 AWS Directory Service Administration Guide 中的什么是 AWS Directory Service?

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::DirectoryService::SimpleAD", "Properties" : { "CreateAlias" : Boolean, "Description" : String, "EnableSso" : Boolean, "Name" : String, "Password" : String, "ShortName" : String, "Size" : String, "VpcSettings" : VpcSettings } }

YAML

Type: AWS::DirectoryService::SimpleAD Properties: CreateAlias: Boolean Description: String EnableSso: Boolean Name: String Password: String ShortName: String Size: String VpcSettings: VpcSettings

属性

CreateAlias

如果设置为 true,则为目录创建一个别名,并将别名分配给该目录。AWS Directory Service 使用别名构建目录的访问 URL,如 http://alias.awsapps.com。默认情况下,该属性设置为 false

Required: No

Type: Boolean

更新要求替换

Description

目录的描述。

Required: No

Type: String

更新要求替换

EnableSso

是否为目录启用单一登录。如果您不指定值,则 AWS CloudFormation 默认禁用单一登录。

Required: No

Type: Boolean

更新要求无需中断

Name

目录的完全限定名称,例如 corp.example.com

Required: Yes

Type: String

更新要求替换

Password

目录管理员的密码。AWS Directory Service 创建具有用户名Administrator 和该密码的目录管理员账户。

Required: Yes

Type: String

更新要求替换

ShortName

内部目录的 NetBIOS 名称,例如 CORP

Required: No

Type: String

更新要求替换

Size

目录的大小。有关有效值,请参阅 AWS Directory Service API Reference 中的 CreateDirectory

Required: Yes

Type: String

更新要求替换

VpcSettings

指定目录服务器的 VPC 设置。

Required: Yes

类型AWS Directory Service SimpleAD VpcSettings

更新要求替换

返回值

Ref

当该资源的逻辑 ID 提供给 Ref 内部函数时,Ref 返回资源 ID。

在以下示例中,Ref 函数返回 myDirectory 目录的 ID,如 d-1a2b3c4d5e

{ "Ref": "myDirectory" }

有关使用 Ref 功能的更多信息,请参阅参考

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

Alias

目录的别名。例如:d-12373a053aalias4-mydirectory-12345abcgmzsk (如果将 CreateAlias 属性设置为 true)。

DnsIpAddresses

目录 DNS 服务器的 IP 地址,如 [ "172.31.3.154", "172.31.63.203" ]

有关使用 Fn::GetAtt 的更多信息,请参见 Fn::GetAtt

示例

以下示例创建一个 Simple AD 目录,目录的 DNS 名称为 corp.example.com

JSON

"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

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

本页内容: