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

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

返回值

Ref

在将此资源的逻辑 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"