LambdaTokenAuthorizer - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

LambdaTokenAuthorizer

Configura una función de Lambda para controlar el acceso a una API con una función de Lambda.

Para obtener más información y ejemplos, consulta Controla el acceso a la API con tu AWS SAM plantilla.

Sintaxis

Para declarar esta entidad en tu plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

Propiedades

DisableFunctionDefaultPermissions

Especifica true si desea evitar que AWS SAM cree automáticamente un recurso AWS::Lambda::Permissions para aprovisionar permisos entre el recurso AWS::Serverless::Api y la función de Lambda autorizadora.

Valor predeterminado: false

Tipo: Booleano

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

FunctionArn

Especifica el ARN de la función de Lambda que proporciona la autorización para la API.

nota

AWS SAM creará automáticamente un recurso AWS::Lambda::Permissions cuando se especifique FunctionArn para AWS::Serverless::Api. El recurso AWS::Lambda::Permissions proporciona permisos entre la API y la función autorizador de Lambda.

Tipo: cadena

Obligatorio: sí

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

FunctionInvokeRole

Añade las credenciales del autorizador a la definición de OpenAPI del autorizador de Lambda.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

FunctionPayloadType

Esta propiedad se puede utilizar para definir el tipo de autorizador Lambda para una API.

Valores válidos: TOKEN o REQUEST

Tipo: cadena

Obligatorio: no

Valor predeterminado: TOKEN

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

Identity

Esta propiedad se puede usar para especificar una solicitud IdentitySource entrante de un autorizador. Esta propiedad solo es necesaria si la propiedad FunctionPayloadType está establecida en REQUEST.

Tipo: LambdaTokenAuthorizationIdentity

Obligatorio: condicional

Compatibilidad con AWS CloudFormation: esta propiedad es exclusiva de AWS SAM y no tiene un equivalente AWS CloudFormation.

Ejemplos

Lambda Tokenauth

YAML

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

Token Auth básico de Lambda

YAML

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