AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::DirectoryService::MicrosoftAD

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

语法

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

JSON

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

YAML

Type: "AWS::DirectoryService::MicrosoftAD" Properties: CreateAlias: Boolean EnableSso: Boolean Name: String Password: String ShortName: String VpcSettings: VpcSettings

属性

CreateAlias

要分配到 AWS 中的 Microsoft Active Directory 的唯一别名。AWS Directory Service 使用别名构建此目录的访问 URL,如 http://alias.awsapps.com。默认情况下,AWS CloudFormation 不创建别名。

Required: No

Type: Boolean

更新要求替换

EnableSso

是否为 AWS 中的 Microsoft Active Directory 启用单一登录。通过单一登录,您目录中的用户可以从加入到此目录的计算机访问特定的 AWS 服务,而不必单独输入其凭证。如果您不指定值,则 AWS CloudFormation 默认禁用单一登录。

Required: No

Type: Boolean

更新要求无需中断

Name

AWS 中 Microsoft Active Directory 的完全限定名称,如 corp.example.com。这种名称不需要公开可解析;它只在您的 VPC 内解析。

Required: Yes

Type: String

更新要求替换

Password

默认管理用户 Admin 的密码。

Required: Yes

Type: String

更新要求替换

ShortName

您的域的 NetBIOS 名称,如 CORP。如果您不指定值,则 AWS Directory Service 使用您的目录 DNS 服务器名称的第一部分。例如,如果您的目录 DNS 服务器名称是 corp.example.com,则 AWS Directory Service 将 CORP 指定为 NetBIOS 名称。

Required: No

Type: String

更新要求替换

VpcSettings

指定 AWS 中 Microsoft Active Directory 服务器的 VPC 设置。

Required: Yes

类型AWS Directory Service MicrosoftAD VpcSettings

更新要求替换

返回值

Ref

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

在下面的示例中,Ref 函数返回 myDirectory 目录的 ID,如 d-12345ab592

{ "Ref": "myDirectory" }

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

Fn::GetAtt

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

Alias

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

DnsIpAddresses

目录 DNS 服务器的 IP 地址,如 [ "192.0.2.1", "192.0.2.2" ]

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

示例

下面的示例在 AWS 中创建一个 Microsoft Active Directory,其中,目录 DNS 名称为 corp.example.com

JSON

"myDirectory" : { "Type" : "AWS::DirectoryService::MicrosoftAD", "Properties" : { "Name" : "corp.example.com", "Password" : { "Ref" : "MicrosoftADPW" }, "ShortName" : { "Ref" : "MicrosoftADShortName" }, "VpcSettings" : { "SubnetIds" : [ { "Ref" : "subnetID1" }, { "Ref" : "subnetID2" } ], "VpcId" : { "Ref" : "vpcID" } } } }

YAML

myDirectory: Type: "AWS::DirectoryService::MicrosoftAD" Properties: Name: "corp.example.com" Password: Ref: MicrosoftADPW ShortName: Ref: MicrosoftADShortName VpcSettings: SubnetIds: - Ref: subnetID1 - Ref: subnetID2 VpcId: Ref: vpcID

本页内容: