AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::Cognito::UserPoolClient

AWS::Cognito::UserPoolClient 资源创建一个 Amazon Cognito 用户池客户端。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

Copy
{ "Type" : "AWS::Cognito::UserPoolClient", "Properties" : { "ClientName" : String, "ExplicitAuthFlows" : [ String, ... ], "GenerateSecret" : Boolean, "ReadAttributes" : [ String, ... ], "RefreshTokenValidity" : Integer, "UserPoolId" : String, "WriteAttributes" : [ String, ... ] } }

YAML

Copy
Type: "AWS::Cognito::UserPoolClient" Properties: ClientName: String, ExplicitAuthFlows: - 字符串 GenerateSecret: Boolean ReadAttributes: - 字符串 RefreshTokenValidity: Integer UserPoolId: String WriteAttributes: - 字符串

属性

ClientName

要创建的用户池客户端的客户端名称。

Required: No

Type: String

更新要求无需中断

MinLength: 1

MaxLength: 128

ExplicitAuthFlows

显式身份验证流程可以是以下选项之一:ADMIN_NO_SRP_AUTHCUSTOM_AUTH_FLOW_ONLY

Required: No

Type: List of Strings

更新要求无需中断

GenerateSecret

指定是否要为正在创建的用户池客户端生成密码。

Required: No

Type: Boolean

更新要求替换

ReadAttributes

读取属性。

Required: No

Type: List of Strings

更新要求无需中断

RefreshTokenValidity

时间限制 (天),超过该限制后,刷新令牌将失效。

Required: No

Type: Integer

更新要求无需中断

UserPoolId

要创建客户端的用户池的用户池 ID。

Required: Yes

Type: String

更新要求替换

WriteAttributes

写入属性。

Required: No

Type: List of Strings

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回 Amazon Cognito 用户池客户端 ID,如 1h57kf5cpq17m0eml12EXAMPLE

有关使用 Ref 功能的更多信息,请参阅参考

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

ClientSecret

客户端密钥,以 String 形式表示。

Name

用户池客户端的名称,以 String 形式表示。

有关使用 Fn::GetAtt 的更多信息,请参见 Fn::GetAtt

本页内容: