LambdaAuthorizer - AWS Serverless Application Model
SintaxePropriedadesExemplos

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á.

LambdaAuthorizer

Configure um autorizador do Lambda para controlar o acesso à sua API HTTP do Amazon API Gateway com uma função AWS Lambda.

Para obter mais informações e exemplos, consulte Trabalhar com AWS Lambda autorizadores para APIs HTTP no Guia do desenvolvedor do API Gateway.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

Propriedades

AuthorizerPayloadFormatVersion

Especifica o formato da carga útil enviada a um autorizador da API HTTP do Lambda. Necessário para autorizadores da API HTTP do Lambda.

Isso é passado para a seção authorizerPayloadFormatVersion de um x-amazon-apigateway-authorizer na seção securitySchemes de uma definição de OpenAPI.

Valores válidos: 1.0 ou 2.0

Tipo: string

Obrigatório: Sim

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

EnableFunctionDefaultPermissions

Por padrão, o recurso da API HTTP não tem permissão para invocar o autorizador do Lambda. Especifique essa propriedade como true para criar automaticamente permissões entre seu recurso de API HTTP e seu autorizador do Lambda.

Tipo: booliano

Obrigatório: não

Valor padrão: false

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

EnableSimpleResponses

Especifica se um autorizador do Lambda retorna uma resposta em um formato simples. Por padrão, um autorizador do Lambda deve retornar uma política do (IAM) AWS Identity and Access Management. Se habilitado, o autorizador do Lambda pode retornar um valor booliano em vez de uma política do IAM.

Isso é passado para a seção enableSimpleResponses de um x-amazon-apigateway-authorizer na seção securitySchemes de uma definição de OpenAPI.

Tipo: booliano

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

FunctionArn

O nome de recurso da Amazon (ARN) da função do Lambda que fornece autorização para a API.

Isso é passado para a seção authorizerUri de um x-amazon-apigateway-authorizer na seção securitySchemes de uma definição de OpenAPI.

Tipo: string

Obrigatório: Sim

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

FunctionInvokeRole

O ARN do perfil do IAM que tem as credenciais necessárias para o API Gateway invocar a função do autorizador. Especifique esse parâmetro se a política baseada em recursos de sua função não conceder permissão ao API Gateway lambda:InvokeFunction.

Isso é passado para a seção authorizerCredentials de um x-amazon-apigateway-authorizer na seção securitySchemes de uma definição de OpenAPI.

Para obter mais informações, consulte Criar um autorizador do Lambda no Guia do desenvolvedor do API Gateway.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Identity

Especifica uma IdentitySource em uma solicitação recebida para um autorizador.

Isso é passado para a seção identitySource de um x-amazon-apigateway-authorizer na seção securitySchemes de uma definição de OpenAPI.

Tipo: LambdaAuthorizationIdentity

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Exemplos

LambdaAuthorizer

exemplo LambdaAuthorizer

YAML

Auth:
  Authorizers:
    MyLambdaAuthorizer:
      AuthorizerPayloadFormatVersion: 2.0
      FunctionArn:
        Fn::GetAtt:
          - MyAuthFunction
          - Arn
      FunctionInvokeRole:
        Fn::GetAtt:
          - LambdaAuthInvokeRole
          - Arn
      Identity:
        Headers:
          - Authorization