LambdaRequestAuthorizer

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

Weitere Informationen und Beispiele finden Sie unter Kontrollieren Sie den API-Zugriff mit Ihrer AWS SAM Vorlage.

Syntax

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

YAML

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

Eigenschaften

DisableFunctionDefaultPermissions

Geben Sie true an, dass nicht AWS SAM automatisch eine AWS::Lambda::Permissions Ressource erstellt wird, um Berechtigungen zwischen Ihrer AWS::Serverless::Api Ressource und der Autorisierungs-Lambda-Funktion bereitzustellen.

Standardwert: false

Typ: Boolesch

Required: No

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

FunctionArn

Geben Sie den Funktions-ARN der Lambda-Funktion an, die die Autorisierung für die API bereitstellt.

Anmerkung

AWS SAM erstellt automatisch eine AWS::Lambda::Permissions Ressource, wenn dies angegeben FunctionArn ist. AWS::Serverless::Api Die AWS::Lambda::Permissions Ressource stellt Berechtigungen zwischen Ihrer API und der Autorisierungs-Lambda-Funktion bereit.

Typ: Zeichenfolge

Erforderlich: Ja

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

FunctionInvokeRole

Fügt der OpenApi Definition des Lambda-Autorisierers Autorisierer-Anmeldeinformationen hinzu.

Typ: Zeichenfolge

Required: No

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

FunctionPayloadType

Diese Eigenschaft kann verwendet werden, um den Typ des Lambda Authorizers für eine API zu definieren.

Zulässige Werte: TOKEN oder REQUEST.

Typ: Zeichenfolge

Required: No

Standardwert: TOKEN

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

Identity

Diese Eigenschaft kann verwendet werden, um IdentitySource in einer eingehenden Anfrage einen Autorisierer anzugeben. Diese Eigenschaft ist nur erforderlich, wenn die FunctionPayloadType Eigenschaft auf REQUEST gesetzt ist.

Typ: LambdaRequestAuthorizationIdentity

Required: Conditional

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

Beispiele

LambdaRequestAuth

YAML

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