LambdaAuthorizer

Configurez un autorisateur Lambda pour contrôler l'accès à votre API HTTP Amazon API Gateway à l'aide d'une fonction. AWS Lambda

Pour plus d'informations et des exemples, consultez la section Travailler avec les AWS Lambda autorisateurs pour les API HTTP dans le Guide du développeur d'API Gateway.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

AuthorizerPayloadFormatVersion

Spécifie le format de la charge utile envoyée à un autorisateur Lambda API HTTP. Requis pour les autorisations Lambda API HTTP.

Cela est transmis à la section authorizerPayloadFormatVersionSection d'un x-amazon-apigateway-authorizer dans la section securitySchemes d'une définition OpenAPI.

Valeurs valides : 1.0 ou 2.0

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

EnableFunctionDefaultPermissions

Par défaut, la ressource d'API HTTP n'est pas autorisée à appeler le mécanisme d'autorisation Lambda. Spécifiez cette propriété comme true pour créer automatiquement des autorisations entre votre ressource d'API HTTP et votre mécanisme d'autorisation Lambda.

Type : valeur booléenne

Obligatoire : non

Valeur par défaut : false

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

EnableSimpleResponses

Spécifie si un autorisateur Lambda renvoie une réponse dans un format simple. Par défaut, un autorisateur Lambda doit renvoyer une politique AWS Identity and Access Management (IAM). Si cette option est activée, l'autorisateur Lambda peut renvoyer une valeur booléenne au lieu d'une politique IAM.

Cela est transmis à la section enableSimpleResponses d'un x-amazon-apigateway-authorizer dans la section securitySchemes d'une définition OpenAPI.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

FunctionArn

L’Amazon Resource Name (ARN) de la fonction Lambda qui procure l’autorisation pour l’API.

Cela est transmis à la section authorizerUri d'un x-amazon-apigateway-authorizer dans la section securitySchemes d'une définition OpenAPI.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

FunctionInvokeRole

L'ARN du rôle IAM qui possède les informations d'identification requises pour que la passerelle API Gateway appelle la fonction de mécanisme d'autorisation. Spécifiez ce paramètre si la stratégie basée sur les ressources de votre fonction n'accorde pas l'autorisation lambda:InvokeFunction API Gateway.

Cela est transmis à la section authorizerCredentials d'un x-amazon-apigateway-authorizer dans la section securitySchemes d'une définition OpenAPI.

Pour plus d'informations, consultez Création d'un mécanisme d'autorisation Lambda dans le Guide du développeur API Gateway.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Identity

Spécifie une IdentitySource dans une demande de mécanisme d'autorisation entrante.

Cela est transmis à la section identitySource d'un x-amazon-apigateway-authorizer dans la section securitySchemes d'une définition OpenAPI.

Type : LambdaAuthorizationIdentity

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est unique AWS SAM et n'a pas d' AWS CloudFormation équivalent.

Exemples

LambdaAuthorizer

LambdaAuthorizer exemple

YAML

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