LambdaAuthorizer

Filtrar vista

All

Configure un autorizador Lambda para controlar el acceso a la API HTTP de Amazon API Gateway con una función. AWS Lambda

Para obtener más información y ejemplos, consulte Cómo trabajar con AWS Lambda autorizadores para HTTP APIs en la Guía para desarrolladores de API Gateway.

Sintaxis

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

YAML

  AuthorizerPayloadFormatVersion: String
  EnableFunctionDefaultPermissions: Boolean
  EnableSimpleResponses: Boolean
  FunctionArn: String
  FunctionInvokeRole: String
  Identity: LambdaAuthorizationIdentity

Propiedades

AuthorizerPayloadFormatVersion

Especifica el formato de la carga enviada a un autorizador de Lambda API HTTP. Necesario para los autorizadores de Lambda API HTTP.

Esto se transfiere a la sección authorizerPayloadFormatVersion de un x-amazon-apigateway-authorizer en la sección securitySchemes de la definición de OpenAPI.

Valores válidos: 1.0 o 2.0

Tipo: cadena

Obligatorio: sí

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

EnableFunctionDefaultPermissions

De forma predeterminada, el recurso de la API HTTP no tiene permiso para invocar el autorizador Lambda. Especifica esta propiedad como true para crear automáticamente permisos entre su recurso de API HTTP y su autorizador Lambda.

Tipo: Booleano

Obligatorio: no

Valor predeterminado: false

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

EnableSimpleResponses

Especifica si un autorizador de Lambda devuelve una respuesta en un formato simple. De forma predeterminada, un autorizador Lambda debe devolver una política AWS Identity and Access Management (IAM). Si está habilitado, el autorizador de Lambda puede devolver un valor booleano en lugar de una política de IAM.

Esto se transfiere a la sección enableSimpleResponses de un x-amazon-apigateway-authorizer en la sección securitySchemes de la definición de OpenAPI.

Tipo: Booleano

Obligatorio: no

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

FunctionArn

El nombre de recurso de Amazon (ARN) de la función de Lambda que proporciona autorización para la API.

Esto se transfiere a la sección authorizerUri de un x-amazon-apigateway-authorizer en la sección securitySchemes de la definición de OpenAPI.

Tipo: cadena

Obligatorio: sí

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

FunctionInvokeRole

El ARN del rol de IAM que tiene las credenciales necesarias para API Gateway para invocar a la función autorizadora. Especifica este parámetro si la política basada en recursos de una función no concede el permiso lambda:InvokeFunction a API Gateway.

Esto se transfiere a la sección authorizerCredentials de un x-amazon-apigateway-authorizer en la sección securitySchemes de la definición de OpenAPI.

Para obtener más información, consulta Creación de un autorizador Lambda en la Guía para desarrolladores de API Gateway.

Tipo: cadena

Obligatorio: no

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

Identity

Especifica un autorizador IdentitySource en una solicitud entrante.

Esto se transfiere a la sección identitySource de un x-amazon-apigateway-authorizer en la sección securitySchemes de la definición de OpenAPI.

Tipo: LambdaAuthorizationIdentity

Obligatorio: no

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

Ejemplos

LambdaAuthorizer

LambdaAuthorizer ejemplo

YAML

Auth:
  Authorizers:
    MyLambdaAuthorizer:
      AuthorizerPayloadFormatVersion: 2.0
      FunctionArn:
        Fn::GetAtt:
          - MyAuthFunction
          - Arn
      FunctionInvokeRole:
        Fn::GetAtt:
          - LambdaAuthInvokeRole
          - Arn
      Identity:
        Headers:
          - Authorization