AWS::Cognito::UserPoolDomain - AWS CloudFormation

AWS::Cognito::UserPoolDomain

AWS::Cognito::UserPoolDomain リソースは、ユーザープールの新しいドメインを作成します。

構文

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

JSON

{ "Type" : "AWS::Cognito::UserPoolDomain", "Properties" : { "CustomDomainConfig" : CustomDomainConfigType, "Domain" : String, "UserPoolId" : String } }

YAML

Type: AWS::Cognito::UserPoolDomain Properties: CustomDomainConfig: CustomDomainConfigType Domain: String UserPoolId: String

プロパティ

CustomDomainConfig

アプリケーションのサインアップページおよびサインインページをホストするカスタムドメインの設定。このオブジェクトを使用して、ACM によって管理される SSL 証明書を指定します。

必須: いいえ

タイプ: CustomDomainConfigType

Update requires: No interruption

Domain

アプリケーションのサインアップページおよびサインインページをホストするドメインのドメイン名。例: auth.example.com。プレフィックスドメインを使用している場合、このフィールドは .auth.[region].amazoncognito.com の前のドメインの最初の部分を示します。

この文字列で使用できるのは、小文字の英文字、数字、ハイフンのみです。最初または最後の文字にハイフンを使用しないでください。サブドメイン名は、ピリオドで区切ります。

必須: はい

タイプ: 文字列

最小: 1

最大: 63

パターン: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Update requires: Replacement

UserPoolId

ユーザープールドメインを関連付けるユーザープールのユーザープール ID。

必須: はい

タイプ: 文字列

最小: 1

最大: 55

パターン: [\w-]+_[0-9a-zA-Z]+

Update requires: Replacement

戻り値

参照番号

このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: physicalResourceId (「Domain」)。次に例を示します。

{ "Ref": "your-test-domain" }

Amazon Cognito ユーザープールドメイン your-test-domain の場合、Ref はユーザープールドメインの名前を返します。

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

ユーザープールの新しいカスタムドメインの作成

次の例では、参照されたユーザープールにカスタムドメイン「my-test-user-pool-domain」を作成します。

JSON

{ "UserPoolDomain":{ "Type":"AWS::Cognito::UserPoolDomain", "Properties":{ "UserPoolId":{ "Ref":"UserPool" }, "Domain":"my-test-user-pool-domain.myapplication.com", "CustomDomainConfig":{ "CertificateArn":{ "Ref":"CertificateArn" } } } } }

YAML

UserPoolDomain: Type: AWS::Cognito::UserPoolDomain Properties: UserPoolId: !Ref UserPool Domain: "my-test-user-pool-domain.myapplication.com" CustomDomainConfig: CertificateArn: !Ref CertificateArn

ユーザープールの新しいデフォルトドメインの作成

次の例では、参照されるユーザープールに新しいデフォルトドメイン「my-test-user-pool-domain」を作成します。

JSON

{ "UserPoolDomain":{ "Type":"AWS::Cognito::UserPoolDomain", "Properties":{ "UserPoolId":{ "Ref":"UserPool" }, "Domain":"my-test-user-pool-domain" } } }

YAML

UserPoolDomain: Type: AWS::Cognito::UserPoolDomain Properties: UserPoolId: !Ref UserPool Domain: "my-test-user-pool-domain"