LambdaRequestAuthorizer

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 Control del acceso a las API de API Gateway.

Sintaxis

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

YAML

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

Propiedades

DisableFunctionDefaultPermissions

Especifique 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

Especifique 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 OpenApi definición del autorizador 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: LambdaRequestAuthorizationIdentity

Obligatorio: condicional

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

Ejemplos

LambdaRequestAuth

YAML

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