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.
Tutorial: Verwenden von Lambda mit API Gateway
In diesem Tutorial erstellen Sie eine REST-API, über die Sie eine Lambda-Funktion mithilfe einer HTTP-Anfrage aufrufen. Ihre Lambda-Funktion führt CRUD-Operationen (Erstellen, Lesen, Aktualisieren und Löschen) für eine DynamoDB-Tabelle durch. Diese Funktion wird hier zu Demonstrationszwecken bereitgestellt, aber Sie werden lernen, eine API-Gateway-REST-API zu konfigurieren, die jede Lambda-Funktion aufrufen kann.
Die Verwendung von API-Gateway bietet Benutzern einen sicheren HTTP-Endpunkt zum Aufrufen Ihrer Lambda-Funktion und kann dabei helfen, große Mengen an Aufrufen an Ihre Funktion zu verwalten, indem der Datenverkehr gedrosselt und API-Aufrufe automatisch validiert und autorisiert werden. API-Gateway bietet auch flexible Sicherheitskontrollen mithilfe von AWS Identity and Access Management (IAM) und Amazon Cognito. Dies ist nützlich für Anwendungsfälle, in denen eine vorherige Autorisierung für Aufrufe zu Ihrer Anwendung erforderlich ist.
Um dieses Tutorial abzuschließen, werden Sie die folgenden Phasen durchlaufen:
-
Erstellen und Konfigurieren einer Lambda-Funktion in Python oder Node.js, um Operationen in einer DynamoDB-Tabelle auszuführen.
-
Erstellen einer REST-API in API Gateway, um eine Verbindung zu Ihrer Lambda-Funktion herzustellen.
-
Erstellen einer DynamoDB-Tabelle und Testen dieser Tabelle mit Ihrer Lambda-Funktion in der Konsole.
-
Bereitstellen Ihrer API und Testen der vollständigen Einrichtung mithilfe von curl in einem Terminal.
Durch Abschluss dieser Phasen lernen Sie, wie Sie mit API Gateway einen HTTP-Endpunkt erstellen, der eine Lambda-Funktion in jeder Größenordnung sicher aufrufen kann. Sie erfahren auch, wie Sie Ihre API bereitstellen und wie Sie sie in der Konsole und durch Senden einer HTTP-Anfrage über ein Terminal testen.
Sections
- Voraussetzungen
- Erstellen einer Berechtigungsrichtlinie
- Erstellen einer Ausführungsrolle
- Erstellen der Funktion
- Aufrufen der Funktion mit der AWS CLI
- Erstellen Sie eine REST-API mit API Gateway
- Erstellen einer Ressource für Ihre REST-API
- Erstellen einer HTTP-POST-Methode
- Erstellen einer DynamoDB-Tabelle
- Testen der Integration von API-Gateway, Lambda und DynamoDB
- Bereitstellen der API
- Verwenden von curl zum Aufrufen Ihrer Funktion mithilfe von HTTP-Anfragen
- Bereinigen Ihrer Ressourcen (optional)
Voraussetzungen
Wenn Sie kein AWS-Konto haben, führen Sie die folgenden Schritte zum Erstellen durch.
Anmeldung für ein AWS-Konto
Öffnen Sie https://portal.aws.amazon.com/billing/signup
. Folgen Sie den Online-Anweisungen.
Bei der Anmeldung müssen Sie auch einen Telefonanruf entgegennehmen und einen Verifizierungscode über die Telefontasten eingeben.
Wenn Sie sich für ein AWS-Konto anmelden, wird ein Root-Benutzer des AWS-Kontos erstellt. Der Root-Benutzer hat Zugriff auf alle AWS-Services und Ressourcen des Kontos. Als bewährte Sicherheitsmethode weisen Sie einem Administratorbenutzer Administratorzugriff zu und verwenden Sie nur den Root-Benutzer, um Aufgaben auszuführen, die Root-Benutzerzugriff erfordern.
AWS sendet Ihnen eine Bestätigungs-E-Mail, sobald die Anmeldung abgeschlossen ist. Sie können jederzeit Ihre aktuelle Kontoaktivität anzeigen und Ihr Konto verwalten. Rufen Sie dazu https://aws.amazon.com/
Nachdem Sie sich für ein AWS-Kontoangemeldet haben, sichern Sie Ihr Root-Benutzer des AWS-Kontos, aktivieren Sie AWS IAM Identity Centerund erstellen Sie einen administrativen Benutzer, damit Sie nicht den Root-Benutzer für alltägliche Aufgaben verwenden.
Schützen Ihres Root-Benutzer des AWS-Kontos
-
Melden Sie sich bei der AWS Management Console
als Kontobesitzer an, indem Sie Root-Benutzer auswählen und Ihre AWS-Konto-E-Mail-Adresse eingeben. Geben Sie auf der nächsten Seite Ihr Passwort ein. Hilfe bei der Anmeldung mit dem Root-Benutzer finden Sie unter Anmelden als Root-Benutzer im AWS-AnmeldungBenutzerhandbuch zu .
-
Aktivieren Sie die Multi-Faktor-Authentifizierung (MFA) für den Root-Benutzer.
Anweisungen dazu finden Sie unter Aktivieren eines virtuellen MFA-Geräts für den Root-Benutzer Ihres AWS-Konto (Konsole) im IAM-Benutzerhandbuch.
Erstellen eines Administratorbenutzers
-
Aktivieren von IAM Identity Center.
Anweisungen finden Sie unter Aktivieren AWS IAM Identity Center im AWS IAM Identity Center Benutzerhandbuch.
-
Im IAM Identity Center gewähren Sie einem administrativen Benutzer administrativen Zugriff.
Ein Tutorial zur Verwendung von IAM-Identity-Center-Verzeichnis als Identitätsquelle finden Sie unter Benutzerzugriff mit dem standardmäßigen IAM-Identity-Center-Verzeichnis konfigurieren im AWS IAM Identity Center-Benutzerhandbuch.
Anmelden als Administratorbenutzer
-
Um sich mit Ihrem IAM-Identity-Center-Benutzer anzumelden, verwenden Sie die Anmelde-URL, die an Ihre E-Mail-Adresse gesendet wurde, als Sie den IAM-Identity-Center-Benutzer erstellt haben.
Hilfe bei der Anmeldung mit einem IAM-Identity-Center-Benutzer finden Sie unter Anmelden beim AWS-Zugangsportal im AWS-Anmeldung Benutzerhandbuch zu.
Wenn Sie die AWS Command Line Interface noch nicht installiert haben, folgen Sie den Schritten unter Installieren oder Aktualisieren der neuesten Version von AWS CLI, um diese zu installieren.
Das Tutorial erfordert zum Ausführen von Befehlen ein Befehlszeilenterminal oder eine Shell. Verwenden Sie unter Linux und macOS Ihre bevorzugte Shell und Ihren bevorzugten Paketmanager.
Anmerkung
In Windows werden einige Bash-CLI-Befehle, die Sie häufig mit Lambda verwenden (z. B. zip
), von den integrierten Terminals des Betriebssystems nicht unterstützt. Um eine in Windows integrierte Version von Ubuntu und Bash zu erhalten, installieren Sie das Windows-Subsystem für Linux
Erstellen einer Berechtigungsrichtlinie
Bevor Sie eine Ausführungsrolle für Ihre Lambda-Funktion erstellen können, müssen Sie zunächst eine Berechtigungsrichtlinie erstellen, um Ihrer Funktion die Berechtigung zum Zugriff auf die erforderlichen AWS-Ressourcen zu erteilen. Für dieses Tutorial erlaubt die Richtlinie Lambda, CRUD-Operationen für eine DynamoDB-Tabelle auszuführen und in Amazon CloudWatch Logs zu schreiben.
So erstellen Sie die Richtlinie
-
Öffnen Sie die Seite Richtlinien
in der IAM-Konsole. -
Wählen Sie Richtlinie erstellen aus.
-
Wählen Sie die Registerkarte JSON aus und kopieren Sie dann die folgende benutzerdefinierte JSON-Richtlinie in den JSON-Editor.
{ "Version": "2012-10-17", "Statement": [ { "Sid": "Stmt1428341300017", "Action": [ "dynamodb:DeleteItem", "dynamodb:GetItem", "dynamodb:PutItem", "dynamodb:Query", "dynamodb:Scan", "dynamodb:UpdateItem" ], "Effect": "Allow", "Resource": "*" }, { "Sid": "", "Resource": "*", "Action": [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents" ], "Effect": "Allow" } ] }
-
Wählen Sie Next: Tags (Weiter: Tags) aus.
-
Klicken Sie auf Weiter: Prüfen.
-
Geben Sie unter Review policy (Richtlinie prüfen) für den Richtlinien-Namen
lambda-apigateway-policy
ein. -
Wählen Sie Richtlinie erstellen aus.
Erstellen einer Ausführungsrolle
Eine Ausführungsrolle ist eine AWS Identity and Access Management (IAM-)Rolle, die einer Lambda-Funktion die Berechtigung zum Zugriff auf AWS-Services und -Ressourcen gewährt. Damit Ihre Funktion Vorgänge an einer DynamoDB-Tabelle ausführen kann, fügen Sie die Berechtigungsrichtlinie an, die Sie im vorherigen Schritt erstellt haben.
So erstellen Sie eine Ausführungsrolle und fügen Ihre benutzerdefinierte Berechtigungsrichtlinie hinzu
-
Öffnen Sie die Seite Roles (Rollen)
in der IAM-Konsole. -
Wählen Sie Rolle erstellen aus.
-
Wählen Sie als Typ der vertrauenswürdigen Entität AWS-Service und dann als Anwendungsfall Lambda aus.
-
Wählen Sie Weiter aus.
-
Geben Sie im Feld für die Richtliniensuche
lambda-apigateway-policy
ein. -
Wählen Sie in den Suchergebnissen die von Ihnen erstellte Richtlinie (
lambda-apigateway-policy
) und dann die Option Next (Weiter) aus. -
Geben Sie unter Role details (Rollendetails) für den Role name (Rollennamen)
lambda-apigateway-role
ein und wählen Sie dann Create role (Rolle erstellen) aus.
Später im Tutorial benötigen Sie den Amazon-Ressourcennamen (ARN) der Rolle, die Sie gerade erstellt haben. Wählen Sie auf der Seite Roles (Rollen) der IAM-Konsole den Namen Ihrer Rolle (lambda-apigateway-role
) und kopieren Sie den Role ARN (Rollen-ARN), der auf der Seite Summary (Zusammenfassung) angezeigt wird.
Erstellen der Funktion
Das folgende Codebeispiel empfängt eine Ereigniseingabe von API-Gateway, die eine Operation angibt, die für die zu erstellende DynamoDB-Tabelle und einige Nutzdaten ausgeführt werden soll. Wenn die von der Funktion empfangenen Parameter gültig sind, führt sie die angeforderte Operation für die Tabelle aus.
Aufrufen der Funktion mit der AWS CLI
Bestätigen Sie vor der Integration Ihrer Funktion mit API-Gateway, dass Sie die Funktion erfolgreich bereitgestellt haben. Erstellen Sie ein Testereignis, das die Parameter enthält, die Ihre API-Gateway-API an Lambda sendet, und verwenden Sie zum Ausführen Ihrer Funktion den AWS CLI invoke
-Befehl..
So rufen Sie die Lambda-Funktion mit der AWS CLI auf
-
Speichern Sie die folgende JSON als Datei mit dem Namen
input.txt
.{ "operation": "echo", "payload": { "somekey1": "somevalue1", "somekey2": "somevalue2" } }
-
Führen Sie den folgenden
invoke
-AWS CLI-Befehl aus.aws lambda invoke --function-name LambdaFunctionOverHttps \ --payload file://input.txt outputfile.txt --cli-binary-format raw-in-base64-out
Die cli-binary-format-Option ist erforderlich, wenn Sie AWS CLI Version 2 verwenden. Um dies zur Standardeinstellung zu machen, führen Sie
aws configure set cli-binary-format raw-in-base64-out
aus. Weitere Informationen finden Sie unter Von AWS CLI unterstützte globale Befehlszeilenoptionen im AWS Command Line Interface-Benutzerhandbuch für Version 2.Sie sollten die folgende Antwort sehen:
{ "StatusCode": 200, "ExecutedVersion": "LATEST" }
-
Bestätigen Sie, dass Ihre Funktion die
echo
-Operation ausgeführt hat, die Sie im JSON-Testereignis angegeben haben. Überprüfen Sie dieoutputfile.txt
-Datei und stellen Sie sicher, dass diese Folgendes enthält:{"somekey1": "somevalue1", "somekey2": "somevalue2"}
Erstellen Sie eine REST-API mit API Gateway
In diesem Schritt erstellen Sie die API-Gateway-REST-API, die Sie zum Aufrufen Ihrer Lambda-Funktion verwenden.
So erstellen Sie die API
-
Öffnen Sie die API Gateway-Konsole
. -
Wählen Sie Create API (API erstellen) aus.
-
Wählen Sie im Feld REST-API die Option Entwickeln aus.
-
Lassen Sie unter API details (API-Details) die Option New API (Neue API) ausgewählt und geben Sie für API Name (API-Name)
DynamoDBOperations
ein. -
Wählen Sie Create API (API erstellen) aus.
Erstellen einer Ressource für Ihre REST-API
Um Ihrer API eine HTTP-Methode hinzuzufügen, müssen Sie zunächst eine Ressource erstellen, mit der diese Methode ausgeführt werden kann. Hier erstellen Sie die Ressource zur Verwaltung Ihrer DynamoDB-Tabelle.
So erstellen Sie die Ressource
-
Wählen Sie in der API Gateway-Konsole
auf der Seite Resources (Ressourcen) für Ihre API die Option Create Resource (Ressource erstellen) aus. -
Geben Sie im Feld Resource details (Ressourcendetails) für Resource name (Ressourcenname)
DynamoDBManager
ein. -
Wählen Sie Create Resource (Ressource erstellen) aus.
Erstellen einer HTTP-POST-Methode
In diesem Schritt erstellen Sie eine Methode (POST
) für Ihre DynamoDBManager
-Ressource. Sie verknüpfen diese POST
-Methode mit Ihrer Lambda-Funktion, sodass API-Gateway Ihre Lambda-Funktion aufruft, wenn die Methode eine HTTP-Anfrage empfängt.
Anmerkung
Für die Zwecke dieses Tutorials wird eine HTTP-Methode (POST
) verwendet, um eine einzelne Lambda-Funktion aufzurufen, die alle Operationen in Ihrer DynamoDB-Tabelle ausführt. In einer realen Anwendung besteht die bewährte Methode darin, für jede Operation eine andere Lambda-Funktion und HTTP-Methode zu verwenden. Weitere Informationen finden Sie bei Serverless Land unter The Lambda monolith
So erstellen Sie die POST-Methode
-
Vergewissern Sie sich, dass die
/DynamoDBManager
-Ressource auf der Seite Resources (Ressourcen) für Ihre API markiert ist. Wählen Sie dann im Bereich Methods (Methoden) die Option Create Method (Methode erstellen) aus. -
Wählen Sie in Method type (Methodentyp) POST.
-
Lassen Sie für den Integration type (Integrationstyp) die Option Lambda function (Lambda-Funktion) ausgewählt.
-
Wählen Sie für die Lambda function (Lambda-Funktion) den Amazon Ressourcennamen (ARN) für Ihre Funktion (
LambdaFunctionOverHttps
). -
Wählen Sie Methode erstellen aus.
Erstellen einer DynamoDB-Tabelle
Erstellen Sie eine leere DynamoDB-Tabelle, an der Ihre Lambda-Funktion CRUD-Operationen ausführt.
Erstellen einer DynamoDB-Tabelle
-
Öffnen Sie die Seite Tables (Tabellen)
in der DynamoDB-Konsole. -
Wählen Sie Create table (Tabelle erstellen) aus.
-
Führen Sie unter Tabellendetails die folgenden Schritte aus:
-
Geben Sie für Table name (Tabellenname)
lambda-apigateway
ein. -
Geben Sie für Partitionsschlüssel
id
ein und behalten Sie den Datentyp als Zeichenfolge bei.
-
-
Behalten Sie unter Table settings (Tabelleneinstellungen) die Default settings (Standardeinstellungen) bei.
-
Wählen Sie Create table (Tabelle erstellen) aus.
Testen der Integration von API-Gateway, Lambda und DynamoDB
Sie können nun die Integration Ihrer APIä-Gateway-API-Methode mit Ihrer Lambda-Funktion und Ihrer DynamoDB-Tabelle testen. Mit der API Gateway-Konsole senden Sie Anfragen mithilfe der Testfunktion der Konsole direkt an Ihre POST
-Methode. In diesem Schritt verwenden Sie zuerst eine create
-Operation, um Ihrer DynamoDB-Tabelle ein neues Element hinzuzufügen, und verwenden dann eine update
-Operation, um das Element zu ändern.
Test 1: So erstellen Sie ein neues Element in Ihrer DynamoDB-Tabelle
-
Wählen Sie in der API-Gateway-Konsole
Ihre API aus ( DynamoDBOperations
). -
Wählen Sie die POST-Methode unter der
DynamoDBManager
Ressource aus. -
Wählen Sie die Registerkarte Test. Möglicherweise müssen Sie die rechte Pfeiltaste wählen, um die Registerkarte anzuzeigen.
-
Lassen Sie unter Test method (Testmethode) die Felder Query strings (Query-Strings) und Headers (Header) leer. Fügen Sie für Request body (Anforderungstext) den folgenden JSON-Code ein:
{ "operation": "create", "payload": { "Item": { "id": "1234ABCD", "number": 5 } } }
-
Wählen Sie Test aus.
Die Ergebnisse, die nach Abschluss des Tests angezeigt werden, sollten den Status
200
anzeigen. Dieser Statuscode zeigt an, dass diecreate
-Operation erfolgreich war.Überprüfen Sie zur Bestätigung, ob Ihre DynamoDB-Tabelle jetzt das neue Element enthält.
-
Öffnen Sie die Seite Tabellen
der DynamoDB-Konsole und wählen Sie die lambda-apigateway
-Tabelle aus. -
Wählen Sie Explore table items (Tabellenelemente erkunden) aus. Im Bereich Items returned (Zurückgegebene Elemente) sollten ein Element mit der id (ID)
1234ABCD
und der number (Nummer)5
angezeigt werden.
Test 2: So aktualisieren Sie das Element in Ihrer DynamoDB-Tabelle
-
Kehren Sie in der API-Gateway-Konsole
zum Bereich Test Ihrer POST-Methode zurück. -
Lassen Sie unter Test method (Testmethode) die Felder Query strings (Query-Strings) und Headers (Header) leer. Fügen Sie für Request body (Anforderungstext) den folgenden JSON-Code ein:
{ "operation": "update", "payload": { "Key": { "id": "1234ABCD" }, "AttributeUpdates": { "number": { "Value": 10 } } } }
-
Wählen Sie Test aus.
Die Ergebnisse, die nach Abschluss des Tests angezeigt werden, sollten den Status
200
anzeigen. Dieser Statuscode zeigt an, dass dieupdate
-Operation erfolgreich war.Überprüfen Sie zur Bestätigung, ob das Element in Ihrer DynamoDB-Tabelle geändert wurde.
-
Öffnen Sie die Seite Tabellen
der DynamoDB-Konsole und wählen Sie die lambda-apigateway
-Tabelle aus. -
Wählen Sie Explore table items (Tabellenelemente erkunden) aus. Im Bereich Items returned (Zurückgegebene Elemente) sollten ein Element mit der id (ID)
1234ABCD
und der number (Nummer)10
angezeigt werden.
Bereitstellen der API
Damit ein Client die API aufrufen kann, müssen Sie eine Bereitstellung und eine zugehörige Stufe erstellen. Eine Phase stellt eine Momentaufnahme Ihrer API dar, einschließlich ihrer Methoden und Integrationen.
So stellen Sie die API bereit
-
Öffnen Sie die APIs-Seite der API-Gateway-Konsole
und wählen Sie die DynamoDBOperations
-API aus. -
Wählen Sie auf der Seite Resources (Ressourcen) für Ihre API die Option Deploy API (API bereitstellen) aus.
-
Wählen Sie für Stage (Stufe) *New stage* (*Neue Stufe*) und geben Sie dann als Stage name (Phasenname)
test
ein. -
Wählen Sie Bereitstellen.
-
Kopieren Sie im Bereich Stage details (Stufendetails) die Invoke URL (Aufruf-URL). Sie werden diese im nächsten Schritt verwenden, um Ihre Funktion mithilfe einer HTTP-Anfrage aufzurufen.
Verwenden von curl zum Aufrufen Ihrer Funktion mithilfe von HTTP-Anfragen
Sie können Ihre Lambda-Funktion jetzt aufrufen, indem Sie eine HTTP-Anfrage an Ihre API senden. In diesem Schritt erstellen Sie ein neues Element in Ihrer DynamoDB-Tabelle und löschen es anschließend.
So rufen Sie die Lambda-Funktion mit curl auf
-
Führen Sie den folgenden
curl
-Befehl mit der Aufruf-URL aus, die Sie im vorherigen Schritt kopiert haben. Wenn Sie curl mit der-d
(Daten)-Option verwenden, wird automatisch die HTTP-POST-Methode verwendet.curl https://
l8togsqxd8.execute-api.us-west-2.amazonaws.com/test
/DynamoDBManager \ -d '{"operation": "create", "payload": {"Item": {"id": "5678EFGH", "number": 15}}}' -
Gehen Sie wie folgt vor, um zu überprüfen, ob der Erstellungsvorgang erfolgreich war:
-
Öffnen Sie die Seite Tabellen
in der DynamoDB-Konsole und wählen Sie die lambda-apigateway
-Tabelle aus. -
Wählen Sie Explore Table Items (Tabellenelemente erkudnen) aus. Im Bereich Items returned (Zurückgegebene Elemente) sollte ein Element mit der id (ID)
5678EFGH
und der number (Nummer)15
angezeigt werden.
-
-
Führen Sie den folgenden
curl
-Befehl aus, um das soeben erstellte Element zu löschen. Verwenden Sie Ihre eigene Aufruf-URL.curl https://
l8togsqxd8.execute-api.us-west-2.amazonaws.com/test
/DynamoDBManager \ -d '{"operation": "delete", "payload": {"Key": {"id": "5678EFGH"}}}' Bestätigen Sie, dass der Löschvorgang erfolgreich war. Stellen Sie im Bereich Items returned (Zurückgegebene Elemente) der Seite Explore items (Elemente erkunden) der DynamoDB-Konsole sicher, dass das Element mit der id (ID)
5678EFGH
nicht mehr in der Tabelle enthalten ist.
Bereinigen Ihrer Ressourcen (optional)
Sie können jetzt die Ressourcen, die Sie für dieses Tutorial erstellt haben, löschen, es sei denn, Sie möchten sie behalten. Durch das Löschen von AWS-Ressourcen, die Sie nicht mehr verwenden, können Sie verhindern, dass unnötige Gebühren in Ihrem AWS-Konto anfallen.
So löschen Sie die Lambda-Funktion:
-
Öffnen Sie die Seite Funktionen
der Lambda-Konsole. -
Wählen Sie die Funktion aus, die Sie erstellt haben.
-
Wählen Sie Aktionen, Löschen aus.
-
Geben Sie
delete
in das Texteingabefeld ein und wählen Sie Delete (Löschen) aus.
So löschen Sie die Ausführungsrolle
-
Öffnen Sie die Seite Roles
in der IAM-Konsole. -
Wählen Sie die von Ihnen erstellte Ausführungsrolle aus.
-
Wählen Sie Löschen aus.
-
Geben Sie den Namen der Rolle in das Texteingabefeld ein und wählen Sie Delete (Löschen) aus.
So löschen Sie die API
-
Öffnen Sie die API-Seite
der API-Gateway-Konsole. -
Wählen Sie die von Ihnen erstellte API aus.
-
Wählen Sie Aktionen, Löschen aus.
-
Wählen Sie Delete (Löschen) aus.
So löschen Sie die DynamoDB-Tabelle
-
Öffnen Sie die Seite Tables (Tabellen)
in der DynamoDB-Konsole. -
Wählen Sie die von Ihnen erstellte Tabelle aus.
-
Wählen Sie Löschen aus.
-
Geben Sie
delete
in das Textfeld ein. -
Wählen Sie Delete Table (Tabelle löschen).