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

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 管理员指南 中的 Simple Active Directory

语法

要在 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,则为目录创建一个别名并将此别名分配给此目录。别名用于构建此目录的访问 URL,如 http://<alias>.awsapps.com。默认情况下,该属性设置为 false

重要

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

必需:否

类型:布尔值

Update requires: Replacement

Description

目录的描述。

必需:否

类型:字符串

最低0

最高128

模式^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$

Update requires: Replacement

EnableSso

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

必需:否

类型:布尔值

Update requires: No interruption

Name

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

必需:是

类型:字符串

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

Update requires: Replacement

Password

目录管理员的密码。目录创建过程将创建一个具有用户名 Administrator 和此密码的目录管理员账户。

如果需要更改管理员账户的密码,请参阅 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

必需:否

类型:字符串

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

Update requires: Replacement

Size

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

必需:是

类型:字符串

允许的值Large | Small

Update requires: Replacement

VpcSettings

一个 DirectoryVpcSettings 对象,此对象包含操作的附加信息。

必需:是

类型VpcSettings

Update requires: Replacement

返回值

Ref

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

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

{ "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 地址,如 [ "172.31.3.154", "172.31.63.203" ]

示例

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

创建 Simple AD 目录

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

另请参阅