メニュー
AWS CloudFormation
ユーザーガイド (API Version 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 とは何ですか?」 (AWS Directory Service Administration Guide) を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

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

プロパティ

CreateAlias

ディレクトリに割り当てる一意のエイリアス。AWS Directory Service はエイリアスを使用して、http://alias.awsapps.com のようなディレクトリの URL にアクセスします。デフォルトでは、AWS CloudFormation はエイリアスを作成しません。

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

ディレクトリのサイズ。有効な値については、「CreateDirectory」(AWS Directory Service API Reference) を参照してください。

Required: Yes

Type: String

更新に伴う要件: 置換

VpcSettings

ディレクトリサーバーの VPC 設定を行います。

Required: Yes

タイプ: AWS Directory Service SimpleAD VpcSettings

更新に伴う要件: 置換

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース ID が返されます。

次のサンプルでは、Ref 関数が、myDirectory ディレクトリの ID (d-1a2b3c4d5e など) を返します。

Copy
{ "Ref": "myDirectory" }

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

Fn::GetAtt は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Alias

ディレクトリのエイリアス。例: d-12373a053a または alias4-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

Copy
"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

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

このページの内容: