AWS::DirectoryService::MicrosoftAD - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::DirectoryService::MicrosoftAD

AWS::DirectoryService::MicrosoftAD 资源在 AWS 中指定 Microsoft Active Directory,以便您的目录用户和组能够使用其现有的凭证访问 AWS 管理控制台和 AWS 应用程序。有关更多信息,请参阅 AWS Directory Service 管理员指南 中的 AWS 托管的 Microsoft AD

语法

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

JSON

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

YAML

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

属性

CreateAlias

为目录指定一个别名并将此别名分配给该目录。别名用于构建此目录的访问 URL,如 http://<alias>.awsapps.com。默认情况下,AWS CloudFormation 不创建别名。

重要

在创建一个别名后,无法删除或重复使用该别名,因此,仅应在绝对必要时使用此操作。

必需:否

类型:布尔值

Update requires: Replacement

Edition

AWS 托管的 Microsoft AD 提供了两种版本:StandardEnterpriseEnterprise 是默认版本。

必需:否

类型:字符串

允许的值Enterprise | Standard

Update requires: Replacement

EnableSso

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

必需:否

类型:布尔值

Update requires: No interruption

Name

AWS 托管的 Microsoft AD 目录的完全限定域名,例如 corp.example.com。此名称将仅在您的 VPC 内解析。该名称不需要可公开解析。

必需:是

类型:字符串

模式^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$

Update requires: Replacement

Password

名为 Admin 的默认管理用户的密码。

如果需要更改管理员账户的密码,请参阅 AWS Directory Service API 参考 中的 ResetUserPassword API 调用。

必需:是

类型:字符串

模式(?=^.{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

ShortName

您的域的 NetBIOS 名称,如 CORP。如果您不指定 NetBIOS 名称,它将默认为您的目录 DNS 的第一个部分。例如,目录 DNS corp.example.comCORP

必需:否

类型:字符串

模式^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$

Update requires: Replacement

VpcSettings

指定 AWS 中的 Microsoft AD 目录服务器的 VPC 设置。

必需:是

类型VpcSettings

Update requires: Replacement

返回值

Ref

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

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

{ "Ref": "myDirectory" }

For more information about using the Ref function, see Ref.

Fn::GetAtt

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

有关使用 Fn::GetAtt 内部函数的更多信息,请参阅 Fn::GetAtt

Alias

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

DnsIpAddresses

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

示例

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

创建 AWS 托管的 Microsoft 目录

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

另请参阅