CognitoAuthorizer

定义 Amazon Cognito 用户群体授权方。

有关更多信息以及示例，请参阅 使用您的 AWS SAM 模板控制 API 访问权限。

语法

要在 AWS Serverless Application Model (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