LambdaTokenAuthorizer - AWS Serverless Application Model
SyntaxEigenschaftenBeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

LambdaTokenAuthorizer

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.

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

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein 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

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

FunctionInvokeRole

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

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein Äquivalent. 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

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig AWS SAM und hat kein 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: LambdaTokenAuthorizationIdentity

Required: Conditional

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

Beispiele

LambdaTokenAuth

YAML

Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn
    Identity:
      Header: MyCustomAuthHeader # OPTIONAL; Default: 'Authorization'
      ValidationExpression: mycustomauthexpression # OPTIONAL
      ReauthorizeEvery: 20 # OPTIONAL; Service Default: 300

BasicLambdaTokenAuth

YAML

Authorizers:
  MyLambdaTokenAuth:
    FunctionArn:
      Fn::GetAtt:
        - MyAuthFunction
        - Arn