LambdaTokenAuthorizer

Configure 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, consulte Controla el acceso a la API con tu AWS SAM plantilla.

Sintaxis

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

YAML

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

Propiedades

DisableFunctionDefaultPermissions

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

Valor predeterminado: false

Tipo: Booleano

Obligatorio: no

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

FunctionArn

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

nota

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

Tipo: cadena

Obligatorio: sí

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

FunctionInvokeRole

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

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad es exclusiva 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

AWS CloudFormation compatibilidad: esta propiedad es exclusiva AWS SAM y no tiene un AWS CloudFormation equivalente.

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

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

Ejemplos

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