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

LambdaTokenAuthorizer

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 Controlar o acesso à API com o modelo do AWS SAM.

Sintaxe

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

Propriedades

DisableFunctionDefaultPermissions

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

Valor padrão: false

Tipo: booliano

Obrigatório: não

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

FunctionArn

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

nota

O AWS SAM criará automaticamente um recurso AWS::Lambda::Permissions quando FunctionArn for especificado para AWS::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

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

FunctionInvokeRole

Adiciona credenciais do autorizador à definição da OpenAPI do autorizador do Lambda.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem 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

Compatibilidade CloudFormation: Essa propriedade é exclusiva do 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. Esta propriedade só será necessária se a FunctionPayloadTypepropriedade estiver definida como REQUEST.

Tipo: LambdaTokenAuthorizationIdentity

Obrigatório: Condicional

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

Exemplos

LambdaTokenAuth

YAML

Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    Identity:
      Header: MyCustomAuthHeader # OPTIONAL; Default: 'Authorization'
      ValidationExpression: mycustomauthexpression # OPTIONAL
      ReauthorizeEvery: 20 # OPTIONAL; Service Default: 300

BasicLambdaTokenAuth

YAML

Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn