View a markdown version of this page

CognitoAuthorizer - AWS Serverless Application Model

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

CognitoAuthorizer

Defina um autorizador do grupo de usuários do Amazon Cognito.

Para ter mais informações e exemplos, consulte Controle o acesso à API com seu AWS SAM modelo.

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

Propriedades

AuthorizationScopes

Lista de escopos de autorização para esse autorizador.

Tipo: lista

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

Identity

Esta propriedade pode ser usada para especificar um IdentitySource em uma solicitação recebida para um autorizador.

Digite: CognitoAuthorizationIdentity

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

UserPoolArn

O (s) ARN (s) do grupo de usuários do Amazon Cognito a ser usado para autorização. Especifique um único ARN como uma string ou vários ARNs como uma lista para usar vários grupos de usuários.

Tipo: String | List

Obrigatório: sim

CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

Exemplos

CognitoAuth

Exemplo de Autenticação Cognito

YAML

Auth: Authorizers: MyCognitoAuth: AuthorizationScopes: - scope1 - scope2 UserPoolArn: Fn::GetAtt: - MyCognitoUserPool - Arn Identity: Header: MyAuthorizationHeader ValidationExpression: myauthvalidationexpression