本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CognitoAuthorizer
定义 Amazon Cognito 用户池授权方。
有关更多信息以及示例,请参阅 控制对 API Gateway API 的访问。
语法
要在您的中声明此实体Amazon Serverless Application Model(Amazon SAM) 模板,请使用以下语法。
YAML
AuthorizationScopes:ListIdentity:CognitoAuthorizationIdentityUserPoolArn:String
属性
-
AuthorizationScopes -
此授权者的授权范围列表。
类型:List
必需:否
Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
-
Identity -
此属性可用于指定
IdentitySource在收到的授权人请求中。类型:Cognito 授权身份
必需:否
Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
-
UserPoolArn -
可以参用用户池/指定要添加本认知授权器的userpool arn
类型:字符串
必需:是
Amazon CloudFormation兼容性:此属性对是唯一的Amazon SAM而且没有Amazon CloudFormation等效项
示例
CognitoAuth
Cognito 身份验证示例
YAML
Auth: Authorizers: MyCognitoAuth: AuthorizationScopes: - scope1 - scope2 UserPoolArn: Fn::GetAtt: - MyCognitoUserPool - Arn Identity: Header: MyAuthorizationHeader ValidationExpression: myauthvalidationexpression