sam local start-api - AWS Serverless Application Model
VerwendungOptionenBeispiel

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.

sam local start-api

Diese Seite enthält Referenzinformationen für die AWS Serverless Application Model Befehlszeilenschnittstelle (AWS SAM CLIsam local start-apiUnterbefehl.

Der sam local start-api Unterbefehl führt Ihre AWS Lambda Funktionen lokal aus, um sie über einen lokalen HTTP Serverhost zu testen.

Verwendung

$ sam local start-api <options>

Optionen

--add-host LIST

Übergibt eine Zuordnung von Hostname zu IP-Adresse an die Hostdatei des Docker-Containers. Dieser Parameter kann mehrfach übergeben werden.

Beispiel: --add-host example.com:127.0.0.1

--beta-features | --no-beta-features

Betafunktionen zulassen oder ablehnen.

--config-env TEXT

Der Umgebungsname, der die Standardparameterwerte in der zu verwendenden Konfigurationsdatei angibt. Der Standardwert ist „default“. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAM CLI Konfigurationsdatei.

--config-file PATH

Der Pfad und der Dateiname der Konfigurationsdatei, die die zu verwendenden Standardparameterwerte enthält. Der Standardwert ist „samconfig.toml“ im Stammverzeichnis des Projektverzeichnisses. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAM CLI Konfigurationsdatei.

--container-env-vars

Optional. Übergeben Sie beim lokalen Debuggen Umgebungsvariablen an den Image-Container.

--container-host TEXT

Host eines lokal emulierten Lambda-Containers. Der Standardwert ist localhost. Wenn du laufen willst AWS SAM CLI in einem Docker-Container auf macOS können Sie angebenhost.docker.internal. Wenn Sie den Container auf einem anderen Host ausführen möchten als AWS SAM CLI, können Sie die IP-Adresse des Remote-Hosts angeben.

--container-host-interface TEXT

Die IP-Adresse der Host-Netzwerkschnittstelle, an die Container-Ports gebunden werden sollen. Der Standardwert ist 127.0.0.1. Wird verwendet0.0.0.0, um an alle Schnittstellen zu binden.

--debug

Aktiviert die Debug-Protokollierung, um die Debug-Meldung zu drucken, die von AWS SAM CLI und zeigt Zeitstempel an.

--debug-args TEXT

Zusätzliche Argumente, die an den Debugger übergeben werden müssen.

--debug-function

Optional. Gibt die Lambda-Funktion an, auf die Debug-Optionen angewendet werden sollen, wenn sie angegeben --warm-containers ist. Dieser Parameter gilt für --debug-port--debugger-path, und. --debug-args

--debug-port, -d TEXT

Wenn angegeben, wird der Lambda-Funktionscontainer im Debug-Modus gestartet und dieser Port auf dem lokalen Host verfügbar gemacht.

--debugger-path TEXT

Der Hostpfad zu einem Debugger, der in den Lambda-Container gemountet wird.

--docker-network TEXT

Der Name oder die ID eines vorhandenen Docker-Netzwerks, mit dem sich die Lambda-Docker-Container verbinden sollen, zusammen mit dem Standard-Bridge-Netzwerk. Wenn dies nicht angegeben ist, stellen die Lambda-Container nur eine Verbindung zum Standard-Bridge-Docker-Netzwerk her.

--docker-volume-basedir, -v TEXT

Der Speicherort des Basisverzeichnisses, in dem die AWS SAM Datei existiert. Wenn Docker auf einem Remote-Computer ausgeführt wird, müssen Sie den Pfad, in dem sich die AWS SAM Datei befindet, auf dem Docker-Computer bereitstellen und diesen Wert so ändern, dass er mit dem Remote-Computer übereinstimmt.

--env-vars, -n PATH

Die JSON Datei, die Werte für die Umgebungsvariablen der Lambda-Funktion enthält.

--force-image-build

Gibt an, ob AWS SAM CLI sollte das Bild, das zum Aufrufen von Funktionen mit Ebenen verwendet wird, neu erstellen.

--help

Zeigt diese Nachricht an und wird beendet.

--hook-name TEXT

Der Name des Hooks, der zur Erweiterung verwendet wird AWS SAM CLI Funktionalität.

Zulässige Werte:terraform.

--host TEXT

Der lokale Hostname oder die IP-Adresse, an die gebunden werden soll (Standard: '127.0.0.1').

--invoke-image TEXT

Das URI des Container-Images, das Sie für Ihre Lambda-Funktionen verwenden möchten. Ruft das Container-Image standardmäßig von Amazon ECR Public ab. AWS SAM Verwenden Sie diese Option, um das Bild von einem anderen Speicherort abzurufen.

Sie können diese Option mehrfach angeben. Jede Instanz dieser Option kann entweder eine Zeichenfolge oder ein Schlüssel-Wert-Paar annehmen. Wenn Sie eine Zeichenfolge angeben, entspricht diese dem URI Container-Image, das für alle Funktionen in Ihrer Anwendung verwendet werden soll. Beispiel, sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8. Wenn Sie ein Schlüssel-Wert-Paar angeben, ist der Schlüssel der Ressourcenname und der Wert ist der Wert URI des Container-Images, das für diese Ressource verwendet werden soll. Zum Beispiel sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.8 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.8 . Mit Schlüssel-Wert-Paaren können Sie verschiedene Container-Images für verschiedene Ressourcen angeben.

--layer-cache-basedir DIRECTORY

Gibt den Speicherort an, in den die von Ihrer Vorlage verwendeten Ebenen heruntergeladen werden.

--log-file, -l TEXT

Die Protokolldatei, an die Laufzeitprotokolle gesendet werden sollen.

--parameter-overrides

Eine Zeichenfolge, die AWS CloudFormation Parameterüberschreibungen enthält, die als Schlüssel-Wert-Paare codiert sind. Verwenden Sie dasselbe Format wie (). AWS Command Line Interface AWS CLI Das AWS SAM CLI Das Format besteht aus expliziten Schlüsselwörtern und Werten, wobei jede Überschreibung durch ein Leerzeichen getrennt ist. Nachfolgend finden Sie zwei Beispiele:

  • --parameter-overrides ParameterKey=hello,ParameterValue=world

  • --parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana

--port, -p INTEGER

Die lokale Portnummer, auf der gewartet werden soll (Standard: '3000').

--profile TEXT

Das spezifische Profil aus Ihrer Anmeldeinformationsdatei, das die AWS Anmeldeinformationen abruft.

--region TEXT

Die AWS Region, in der die Bereitstellung erfolgen soll. Beispiel: us-east-1.

--save-params

Speichern Sie die Parameter, die Sie in der Befehlszeile angeben, in der AWS SAM Konfigurationsdatei.

--shutdown

Emuliert nach Abschluss des Aufrufs ein Shutdown-Ereignis, um zu testen, wie Erweiterungen das Shutdown-Verhalten behandeln.

--skip-prepare-infra

Überspringt die Vorbereitungsphase, wenn keine Änderungen an der Infrastruktur vorgenommen wurden. Zusammen mit der --hook-name Option verwenden.

--skip-pull-image

Gibt an, ob das Abrufen des neuesten Docker-Images für die Lambda-Laufzeit übersprungen werden CLI soll.

--ssl-cert-file PATH

Pfad zur SSL Zertifikatsdatei (Standard: Keine). Wenn Sie diese Option verwenden, muss die --ssl-key-file Option auch verwendet werden.

--ssl-key-file PATH

Pfad zur SSL Schlüsseldatei (Standard: Keine). Wenn Sie diese Option verwenden, muss die --ssl-cert-file Option auch verwendet werden.

--static-dir, -s TEXT

Alle statischen Asset-Dateien (z. B.CSS/JavaScript/HTML), die sich in diesem Verzeichnis befinden, werden unter angezeigt/.

--template, -t PATH

Die AWS SAM Vorlagendatei.

Anmerkung

Wenn Sie diese Option angeben, werden nur die Vorlage und die lokalen Ressourcen AWS SAM geladen, auf die sie verweist.

--terraform-plan-file

Der relative oder absolute Pfad zu Ihrem lokalen Terraform Plandatei bei Verwendung der AWS SAM CLI mit Terraform Cloud. Für diese Option muss der --hook-name Wert auf gesetzt seinterraform.

--warm-containers [EAGER | LAZY]

Optional. Gibt an, wie AWS SAM CLI verwaltet Container für jede Funktion.

Zwei Optionen sind verfügbar:

   EAGER: Container für alle Funktionen werden beim Start geladen und bleiben zwischen Aufrufen bestehen.

   LAZY: Container werden nur geladen, wenn jede Funktion zum ersten Mal aufgerufen wird. Diese Container bleiben für weitere Aufrufe bestehen.

Beispiel

Das folgende Beispiel startet einen lokalen Server, über den Sie Ihre Anwendung testen können. API Damit dieser Befehl funktioniert, muss die Anwendung installiert sein und Docker muss ausgeführt werden.

$ sam local start-api --port 3000