Erstellen einer Berechtigungsrichtlinie Erstellen einer Ausführungsrolle So erstellen Sie die Lambda-Funktion:Testen der Funktion 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)

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.

In diesem Tutorial verwendete Services und Ressourcen

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.

Tipp

Lambda bietet zwei Möglichkeiten, Ihre Funktion über einen HTTP-Endpunkt aufzurufen: API Gateway und Lambda-Funktions-URLs. Wenn Sie sich nicht sicher sind, welche Methode für Ihren Anwendungsfall am besten geeignet ist, siehe Wählen Sie eine Methode, um Ihre Lambda-Funktion über eine HTTP-Anfrage aufzurufen.

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.

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 ermöglicht die Richtlinie Lambda, CRUD-Vorgänge an einer DynamoDB-Tabelle durchzufü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.

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 Create role 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.

So erstellen Sie die Lambda-Funktion:

Öffnen Sie die Funktionsseite der Lambda-Konsole und wählen Sie Funktion erstellen aus.
Wählen Sie Von Grund auf neu schreiben aus.
Geben Sie für Function name (Funktionsname) LambdaFunctionOverHttps ein.
Wählen Sie für Laufzeit die neueste Node.js- oder Python-Laufzeit aus.
Erweitern Sie unter Berechtigungen die Option Standardausführungsrolle ändern.
Wählen Sie Vorhandene Rolle verwenden und anschließend die zuvor erstellte Rolle „lambda-apigateway-role“ aus.
Wählen Sie Funktion erstellen.

Ersetzen Sie im Bereich Codequelle den Standardcode durch den folgenden Node.js- oder Python-Code.

Node.js

Die Einstellung „region“ muss mit der AWS-Region übereinstimmen, in der Sie die Funktion bereitstellen und die DynamoDB-Tabelle erstellen.

Beispiel index.mjs


import { DynamoDBDocumentClient, PutCommand, GetCommand, 
         UpdateCommand, DeleteCommand} from "@aws-sdk/lib-dynamodb";
import { DynamoDBClient } from "@aws-sdk/client-dynamodb";

const ddbClient = new DynamoDBClient({ region: "us-east-2" });
const ddbDocClient = DynamoDBDocumentClient.from(ddbClient);

// Define the name of the DDB table to perform the CRUD operations on
const tablename = "lambda-apigateway";

/**
 * Provide an event that contains the following keys:
 *
 *   - operation: one of 'create,' 'read,' 'update,' 'delete,' or 'echo'
 *   - payload: a JSON object containing the parameters for the table item
 *     to perform the operation on
 */
export const handler = async (event, context) => {
   
     const operation = event.operation;
   
     if (operation == 'echo'){
          return(event.payload);
     }
     
    else { 
        event.payload.TableName = tablename;
        let response;
        
        switch (operation) {
          case 'create':
               response = await ddbDocClient.send(new PutCommand(event.payload));
               break;
          case 'read':
               response = await ddbDocClient.send(new GetCommand(event.payload));
               break;
          case 'update':
               response = ddbDocClient.send(new UpdateCommand(event.payload));
               break;
          case 'delete':
               response = ddbDocClient.send(new DeleteCommand(event.payload));
               break;
          default:
            response = 'Unknown operation: ${operation}';
          }
        console.log(response);
        return response;
    }
};

Python

Beispiel lambda_function.py


import boto3

# Define the DynamoDB table that Lambda will connect to
table_name = "lambda-apigateway"

# Create the DynamoDB resource
dynamo = boto3.resource('dynamodb').Table(table_name)

# Define some functions to perform the CRUD operations
def create(payload):
    return dynamo.put_item(Item=payload['Item'])

def read(payload):
    return dynamo.get_item(Key=payload['Key'])

def update(payload):
    return dynamo.update_item(**{k: payload[k] for k in ['Key', 'UpdateExpression', 
    'ExpressionAttributeNames', 'ExpressionAttributeValues'] if k in payload})

def delete(payload):
    return dynamo.delete_item(Key=payload['Key'])

def echo(payload):
    return payload

operations = {
    'create': create,
    'read': read,
    'update': update,
    'delete': delete,
    'echo': echo,
}

def lambda_handler(event, context):
    '''Provide an event that contains the following keys:
      - operation: one of the operations in the operations dict below
      - payload: a JSON object containing parameters to pass to the 
        operation being performed
    '''
    
    operation = event['operation']
    payload = event['payload']
    
    if operation in operations:
        return operations[operation](payload)
        
    else:
        raise ValueError(f'Unrecognized operation "{operation}"')

Anmerkung

In diesem Beispiel ist der Name der DynamoDB-Tabelle als Variable in Ihrem Funktionscode definiert. In einer realen Anwendung besteht die bewährte Methode darin, diesen Parameter als Umgebungsvariable zu übergeben und den Tabellennamen nicht fest zu codieren. Weitere Informationen finden Sie unter Verwenden von AWS Lambda-Umgebungsvariablen.

Wählen Sie im Abschnitt BEREITSTELLEN die Option Bereitstellen aus, um den Code Ihrer Funktion zu aktualisieren:

Testen der Funktion

Bestätigen Sie vor der Integration Ihrer Funktion mit API-Gateway, dass Sie die Funktion erfolgreich bereitgestellt haben. Senden Sie mithilfe der Lambda-Konsole ein Testereignis an Ihre Funktion.

Wählen Sie auf der Lambda-Konsolenseite für Ihre Funktion die Registerkarte Test aus.
Scrollen Sie nach unten zum Abschnitt Ereignis-JSON und ersetzen Sie das Standardereignis durch Folgendes. Dieses Ereignis entspricht der von der Lambda-Funktion erwarteten Struktur.
```
{
    "operation": "echo",
    "payload": {
        "somekey1": "somevalue1",
        "somekey2": "somevalue2"
    }
}
```
Wählen Sie Test aus.
Erweitern Sie unter Funktionsausführung: erfolgreich die Option Details. Sie sollten die folgende Antwort sehen:
```
{
  "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 Ressourcen für Ihre API die Option 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:
1. Geben Sie unter Tabellenname lambda-apigateway ein.
2. 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 unter der Ressource DynamoDBManager die Methode POST.
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 die create-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. Beispiel:

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"
        },
        "UpdateExpression": "SET #num = :newNum",
        "ExpressionAttributeNames": {
            "#num": "number"
        },
        "ExpressionAttributeValues": {
            ":newNum": 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 die update-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 führen dann Lese-, Aktualisierungs- und Löschvorgänge für dieses Element durch.

So erstellen Sie mit curl ein Element in Ihrer DynamoDB-Tabelle

Öffnen Sie ein Terminal oder eine Eingabeaufforderung auf Ihrem lokalen Computer und führen Sie den folgenden curl-Befehl mit der im vorherigen Schritt kopierten Aufruf-URL aus. Dieser Befehl verwendet die folgenden Optionen:
- -H: Fügt der Anforderung einen benutzerdefinierten Header hinzu. Hier wird der Inhaltstyp als JSON angegeben.
- -d: Sendet Daten im Anforderungstext. Diese Option verwendet standardmäßig eine HTTP-POST-Methode.
Linux/macOS
```
curl https://l8togsqxd8.execute-api.us-east-2.amazonaws.com/test/DynamoDBManager \
-H "Content-Type: application/json" \
-d '{"operation": "create", "payload": {"Item": {"id": "5678EFGH", "number": 15}}}'
```
PowerShell
```
curl.exe 'https://l8togsqxd8.execute-api.us-east-2.amazonaws.com/test/DynamoDBManager' -H 'Content-Type: application/json' -d '{\"operation\": \"create\", \"payload\": {\"Item\": {\"id\": \"5678EFGH\", \"number\": 15}}}'
```
Wenn der Vorgang erfolgreich war, sollten Sie eine Antwort mit einem HTTP-Statuscode von 200 erhalten.
Sie können auch die DynamoDB-Konsole verwenden, um zu überprüfen, ob sich das neue Element in Ihrer Tabelle befindet, indem Sie Folgendes tun:
1. Öffnen Sie die Seite Tabellen in der DynamoDB-Konsole und wählen Sie die lambda-apigateway-Tabelle aus.
2. 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.

So lesen Sie das Element in Ihrer DynamoDB-Tabelle mit curl

Führen Sie in Ihrem Terminal oder Ihrer Eingabeaufforderung den folgenden curl-Befehl aus, um den Wert des soeben erstellten Elements zu lesen. Verwenden Sie Ihre eigene Aufruf-URL.

Je nachdem, ob Sie den Node.js-Funktionscode oder den Python-Funktionscode gewählt haben, sollten Sie eine der folgenden Ausgaben sehen:

So aktualisieren Sie das Element in Ihrer DynamoDB-Tabelle mit curl

Führen Sie in Ihrem Terminal oder Ihrer Eingabeaufforderung den folgenden curl-Befehl aus, um das soeben erstellte Element durch Ändern des number-Werts zu aktualisieren. Verwenden Sie Ihre eigene Aufruf-URL.

Um zu bestätigen, dass der Wert von number für das Element aktualisiert wurde, führen Sie einen weiteren Lesebefehl aus:

So löschen Sie das Element in Ihrer DynamoDB-Tabelle mit curl

Führen Sie in Ihrem Terminal oder Ihrer Eingabeaufforderung den folgenden curl-Befehl aus, um das soeben erstellte Element zu löschen. Verwenden Sie Ihre eigene Aufruf-URL.

Bestätigen Sie, dass der Löschvorgang erfolgreich war. Stellen Sie im Bereich Zurückgegebene Elemente der Seite Elemente entdecken der DynamoDB-Konsole sicher, dass das Element mit der 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-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 Actions, Delete.
Geben Sie confirm 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 Actions, Delete.
Wählen Sie Delete (Löschen).

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 Delete (Löschen).
Geben Sie delete in das Textfeld ein.
Wählen Sie Delete Table (Tabelle löschen).

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

API Gateway

Fehler