LambdaRequestAuthorizer

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

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

Sintaxe

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

YAML

DisableFunctionDefaultPermissions: Boolean
FunctionArn: String
FunctionInvokeRole: String
FunctionPayloadType: String
Identity: LambdaRequestAuthorizationIdentity

Propriedades

DisableFunctionDefaultPermissions

Especifique true para evitar a criação automática AWS SAM de um AWS::Lambda::Permissions recurso para provisionar permissões entre seu AWS::Serverless::Api recurso e a função Lambda do autorizador.

Valor padrão: false

Tipo: booliano

Obrigatório: não

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

FunctionArn

Especifique a função ARN da função do Lambda que fornece autorização para a API.

nota

AWS SAM criará automaticamente um AWS::Lambda::Permissions recurso quando FunctionArn for especificado paraAWS::Serverless::Api. O recurso AWS::Lambda::Permissions fornece permissões entre sua API e a função do Lambda do autorizador.

Tipo: string

Obrigatório: Sim

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

FunctionInvokeRole

Adiciona credenciais do autorizador à OpenApi definição do autorizador Lambda.

Tipo: string

Obrigatório: não

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

FunctionPayloadType

Esta propriedade pode ser usada para definir o tipo de autorizador do Lambda para uma API.

Valores válidos: TOKEN ou REQUEST

Tipo: string

Obrigatório: não

Padrão: TOKEN

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

Identity

Esta propriedade pode ser usada para especificar um IdentitySource em uma solicitação recebida para um autorizador. Essa propriedade só é necessária se a propriedade do FunctionPayloadType estiver definida como REQUEST.

Tipo: LambdaRequestAuthorizationIdentity

Obrigatório: Condicional

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

Exemplos

LambdaRequestAuth

YAML

Authorizers:
  MyLambdaRequestAuth:
    FunctionPayloadType: REQUEST
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    FunctionInvokeRole:
      Fn::GetAtt:
        - LambdaAuthInvokeRole
        - Arn
    Identity:
      Headers:
        - Authorization1