AWS::DirectoryService::MicrosoftAD - AWS CloudFormation

AWS::DirectoryService::MicrosoftAD

AWS::DirectoryService::MicrosoftAD リソースは、AWS に Microsoft Active Directory を指定して、ディレクトリユーザーとグループが既存の認証情報を使用して AWS マネジメントコンソールと AWS アプリケーションにアクセスできるようにします。詳細については、AWS Directory Service 管理者ガイドの「AWS Managed 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

ディレクトリの別名を指定し、ディレクトリにエイリアスを割り当てます。エイリアスは、http://<alias>.awsapps.com などのディレクトリのアクセス URL を構築するために使用されます。デフォルトでは、AWS CloudFormation はエイリアスを作成しません。

重要

エイリアスが作成された後、削除または再利用することはできません。このため、このオペレーションが絶対に必要な場合にのみ使用できます。

必須: いいえ

タイプ: ブール値

Update requires: Replacement

Edition

AWS Managed Microsoft AD は、StandardEnterprise の 2 つのエディションで利用できます。Enterprise はデフォルトです。

必須: いいえ

タイプ: 文字列

許可された値: Enterprise | Standard

Update requires: Replacement

EnableSso

AWS の Microsoft Active Directory でシングルサインオンを有効にするかどうか。シングルサインオンを使用すると、ディレクトリ内のユーザーが認証情報を別個に入力しなくてもディレクトリに結合されているコンピュータから特定の AWS サービスにアクセスすることができます。値を指定しない場合、AWS CloudFormation はデフォルトでシングルサインオンを無効にします。

必須: いいえ

タイプ: ブール値

Update requires: No interruption

Name

corp.example.com などの AWS Managed Microsoft AD ディレクトリ の完全修飾ドメイン名。この名前は、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 Active Directory サーバーの VPC 設定を指定します。

必須: はい

タイプ: VpcSettings

Update requires: Replacement

戻り値

参照番号

このリソースの論理 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-12373a053a または alias4-mydirectory-12345abcgmzsk (CreateAlias プロパティを true に設定した場合)。

DnsIpAddresses

ディレクトリの DNS サーバーの IP アドレス ([ "192.0.2.1", "192.0.2.2" ] など)。

次の例では、AWS に Microsoft Active Directory を作成します。ディレクトリの DNS 名は corp.example.com のようになります。

AWS Managed 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

以下の資料も参照してください。