LambdaAuthorizer

Konfigurieren Sie einen Lambda-Authorizer, um den Zugriff auf Ihre Amazon API Gateway Gateway-HTTP-API mit einer AWS Lambda Funktion zu kontrollieren.

Weitere Informationen und Beispiele finden Sie unter Arbeiten mit AWS Lambda Autorisierern für HTTP APIs im API Gateway Developer Guide.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

YAML

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

Eigenschaften

AuthorizerPayloadFormatVersion

Gibt das Format der Nutzlast an, die an einen HTTP-API-Lambda-Genehmiger gesendet wird. Für HTTP-API-Lambda-Genehmiger erforderlich.

Dies wird an den authorizerPayloadFormatVersion Abschnitt von und x-amazon-apigateway-authorizer im securitySchemes Abschnitt einer OpenAPI-Definition weitergegeben.

Zulässige Werte: 1.0 oder 2.0.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

EnableFunctionDefaultPermissions

Standardmäßig wird der HTTP-API-Ressource keine Berechtigung zum Aufrufen des Lambda-Autorisierers erteilt. Geben Sie diese Eigenschaft antrue, um automatisch Berechtigungen zwischen Ihrer HTTP-API-Ressource und Ihrem Lambda-Authorizer zu erstellen.

Typ: Boolesch

Required: No

Standardwert: false

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

EnableSimpleResponses

Gibt an, ob ein Lambda-Genehmiger eine Antwort in einem einfachen Format zurückgibt. Standardmäßig muss ein Lambda-Autorisierer eine AWS Identity and Access Management (IAM-) Richtlinie zurückgeben. Wenn diese Option aktiviert ist, kann der Lambda-Genehmiger anstelle einer IAM-Richtlinie einen booleschen Wert zurückgeben.

Dies wird an den enableSimpleResponses Abschnitt von und x-amazon-apigateway-authorizer im securitySchemes Abschnitt einer OpenAPI-Definition weitergegeben.

Typ: Boolesch

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

FunctionArn

Der Amazon-Ressourcenname (ARN) der Lambda-Funktion, die die Autorisierung für die API bereitstellt.

Dies wird an den authorizerUri Abschnitt von und x-amazon-apigateway-authorizer im securitySchemes Abschnitt einer OpenAPI-Definition weitergegeben.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

FunctionInvokeRole

Der ARN der IAM-Rolle, die über die Anmeldeinformationen verfügt, die API Gateway benötigt, um die Autorisierungsfunktion aufzurufen. Geben Sie diesen Parameter an, wenn die ressourcenbasierte Richtlinie Ihrer Funktion keine lambda:InvokeFunction API-Gateway-Berechtigung gewährt.

Dies wird an den authorizerCredentials Abschnitt von und x-amazon-apigateway-authorizer im securitySchemes Abschnitt einer OpenAPI-Definition weitergegeben.

Weitere Informationen finden Sie unter Create a Lambda Authorizer im API Gateway Developer Guide.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

Identity

Gibt IdentitySource in einer eingehenden Anfrage nach einem Autorisierer ein an.

Dies wird an den identitySource Abschnitt von und x-amazon-apigateway-authorizer im securitySchemes Abschnitt einer OpenAPI-Definition weitergegeben.

Typ: LambdaAuthorizationIdentity

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

Beispiele

LambdaAuthorizer

LambdaAuthorizer Beispiel

YAML

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