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