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.
gleiche lokale Start-API
Diese Seite enthält Referenzinformationen für AWS Serverless Application Model Befehlszeilenschnittstelle (AWS SAM CLI) sam local start-api Unterbefehl.
-
Für eine Einführung in die AWS SAM CLI, siehe Was ist der AWS SAM CLI?
-
Eine Dokumentation zur Verwendung des AWS SAM CLI
sam local start-apiUnterbefehl, siehe Einführung in das Testen mit dieselbe lokale Start-API.
Das sam local start-api Unterbefehl führt deinen aus AWS Lambda Event-Funktionen können lokal über einen lokalen HTTP-Serverhost getestet werden.
Nicht verwenden sam local start-api mit nicht vertrauenswürdigem Code, da er Ihre Funktionen in Ihrer lokalen Umgebung ausführt. Für eine vollständige Isolierung testen Sie stattdessen den Code im Lambda-Service.
Usage
$sam local start-api<options>
Optionen
--add-hostLIST-
Übergibt die Zuordnung eines Hostnamens zur IP-Adresse an die Hostdatei des Docker-Containers. Dieser Parameter kann mehrfach übergeben werden.
Beispiel
Beispiel:
--add-hostexample.com:127.0.0.1 --beta-features | --no-beta-features-
Betafunktionen zulassen oder ablehnen.
--config-envTEXT-
Der Umgebungsname, der die Standardparameterwerte in der zu verwendenden Konfigurationsdatei angibt. Der Standardwert ist „default“. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAMCLIKonfigurationsdatei.
--config-filePATH-
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 SAMCLIKonfigurationsdatei.
--container-env-vars-
Optional. Übergeben Sie beim lokalen Debuggen Umgebungsvariablen an den Image-Container.
--container-hostTEXT-
Host des lokal emulierten Lambda-Containers. Der Standardwert ist
localhost. Wenn du rennen willst AWS SAM CLI in einem Docker-Container unter macOS können Sie angebenhost.docker.internal. Wenn Sie den Container auf einem anderen Host ausführen möchten als AWS SAM CLI, Sie können die IP-Adresse des Remote-Hosts angeben. --container-host-interfaceTEXT-
Die IP-Adresse der Host-Netzwerkschnittstelle, an die Container-Ports gebunden werden sollen. Der Standardwert ist
127.0.0.1. Verwenden0.0.0.0um an alle Schnittstellen zu binden. --container-dnsTEXT-
Gibt einen benutzerdefinierten DNS-Server für den Docker-Container an. Dieser Parameter kann mehrfach übergeben werden, um mehrere DNS-Server anzugeben.
Beispiel
Beispiel:
--container-dns8.8.8.8 --debug-
Schaltet die Debug-Protokollierung ein, um die von der AWS SAM CLI und Zeitstempel anzeigen.
--debug-argsTEXT-
Zusätzliche Argumente, die an den Debugger übergeben werden sollen.
--debug-function-
Optional. Gibt die Lambda-Funktion an, auf die Debug-Optionen angewendet werden sollen, wenn
--warm-containersist angegeben. Dieser Parameter gilt für--debug-port,--debugger-path, und--debug-args. --debug-port, -dTEXT-
Wenn angegeben, startet der Lambda-Funktionscontainer im Debug-Modus und macht diesen Port auf dem lokalen Host verfügbar.
--debugger-pathTEXT-
Der Hostpfad zu einem Debugger, der in den Lambda-Container gemountet wird.
--docker-networkTEXT-
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, -vTEXT-
Der Speicherort des Basisverzeichnisses, in dem AWS SAM Datei existiert. Wenn Docker auf einem Remote-Computer läuft, müssen Sie den Pfad mounten, in dem AWS SAM Eine Datei ist auf dem Docker-Computer vorhanden. Ändern Sie diesen Wert so, dass er dem Remote-Computer entspricht.
--env-vars, -nPATH-
Das JSON oder
.envDatei, die Werte für die Umgebungsvariablen der Lambda-Funktion enthält. Das Dateiformat wird automatisch erkannt. --force-image-build-
Gibt an, ob AWS SAM CLI sollte das Image, das zum Aufrufen von Funktionen mit Ebenen verwendet wird, neu erstellen.
--help-
Zeigt diese Meldung an und beendet das Programm.
--hook-nameTEXT-
Der Name des Hooks, der zur Erweiterung verwendet wird AWS SAM CLI Funktionalität.
Zulässige Werte:
terraform. --hostTEXT-
Der lokale Hostname oder die IP-Adresse, an die gebunden werden soll (Standard: '127.0.0.1').
--invoke-imageTEXT-
Die URI des Container-Images, das Sie für Ihre Lambda-Funktionen verwenden möchten.
Für Lambda-Funktionen mit
PackageType: Zip, dies überschreibt das Runtime-Basis-Image. In der Standardeinstellung AWS SAM ruft das Container-Image aus Amazon ECR Public ab. Verwenden Sie diese Option, um das Bild von einem anderen Ort abzurufen.Für Lambda-Funktionen mit
PackageType: Image, das überschreibtImageUriaus der erstellten Vorlage. Verwenden Sie dies, um lokal ein anderes Anwendungs-Image aufzurufen, ohne Ihre Vorlage zu ändern.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, ist dies die URI des Container-Images, das für alle Funktionen in Ihrer Anwendung verwendet werden soll. Beispiel,
sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.13. Wenn Sie ein Schlüssel-Wert-Paar angeben, ist der Schlüssel der Ressourcenname, und der Wert ist der URI des Container-Images, das für diese Ressource verwendet werden soll. Beispiel,sam local start-api --invoke-image public.ecr.aws/sam/emu-python3.13 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.13. Mit Schlüssel-Wert-Paaren können Sie verschiedene Container-Images für verschiedene Ressourcen angeben. --layer-cache-basedirDIRECTORY-
Gibt den Speicherort basedir an, in den die von deiner Vorlage verwendeten Ebenen heruntergeladen werden.
--log-file, -lTEXT-
Die Protokolldatei, an die Laufzeitprotokolle gesendet werden sollen.
--no-memory-limit-
Entfernt die Speicherbeschränkung im Container während des lokalen Aufrufs, auch wenn der Speicher in der konfiguriert ist AWS SAM Vorlage.
--no-watch-
Deaktiviert das Ansehen von Dateien bei Verwendung mit
--warm-containers. Wenn angegeben, AWS SAM CLI überwacht Ihren Quellcode oder Ihre Vorlage nicht auf Änderungen, und Warm-Container werden bei Codeänderungen nicht automatisch neu gestartet. Um lokale Änderungen zu übernehmen, beenden Sie den Befehl und führen Sie ihn erneut aus.Verwenden Sie diese Option, wenn das Ansehen von Dateien zu einer hohen CPU-Auslastung führt oder I/O Overhead, z. B. in großen Monorepos, Umgebungen, in denen Antivirensoftware gescannt wird, oder bei Projekten, bei denen sich mehrere Lambda-Funktionen eine gemeinsame
CodeUri.Diese Option wird ignoriert, wenn
--warm-containersist nicht spezifiziert. --parameter-overrides-
Eine Zeichenfolge, die enthält CloudFormation Parameterüberschreibungen, die als Schlüssel-Wert-Paare kodiert sind. Verwenden Sie dasselbe Format wie AWS Command Line Interface (AWS CLI). Das AWS SAM CLI format besteht aus expliziten Schlüssel- und Wert-Schlüsselwörtern. Jede Überschreibung ist durch ein Leerzeichen getrennt. 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, -pINTEGER-
Die lokale Portnummer, auf der gewartet werden soll (Standard: '3000').
--profileTEXT-
Das spezifische Profil aus Ihrer Anmeldeinformationsdatei, das abgerufen wird AWS Anmeldeinformationen.
--regionTEXT-
Die AWS Region, in der bereitgestellt werden soll. Beispiel: us-east-1.
--save-params-
Speichern Sie die Parameter, die Sie in der Befehlszeile angeben, im AWS SAM Konfigurationsdatei.
--shutdown-
Emuliert nach Abschluss des Aufrufs ein Shutdown-Ereignis, um zu testen, wie die Erweiterung das Verhalten beim Herunterfahren handhabt.
--skip-prepare-infra-
Überspringt die Vorbereitungsphase, wenn keine Änderungen an der Infrastruktur vorgenommen wurden. Verwenden Sie mit dem
--hook-nameOption. --skip-pull-image-
Gibt an, ob die CLI das Herunterladen des neuesten Docker-Images für die Lambda-Laufzeit überspringen soll.
--ssl-cert-filePATH-
Pfad zur SSL-Zertifikatsdatei (Standard: Keine). Wenn Sie diese Option verwenden, wird
--ssl-key-fileDie Option muss ebenfalls verwendet werden. --ssl-key-filePATH-
Pfad zur SSL-Schlüsseldatei (Standardeinstellung: Keine). Wenn Sie diese Option verwenden, wird
--ssl-cert-fileDie Option muss ebenfalls verwendet werden. --static-dir, -sTEXT-
Jedes statische Asset (z. B. CSS/JavaScript/HTML) Dateien, die sich in diesem Verzeichnis befinden, werden unter angezeigt
/. --template, -tPATH-
Das AWS SAM Vorlagendatei.
AnmerkungWenn Sie diese Option angeben, AWS SAM lädt nur die Vorlage und die lokalen Ressourcen, auf die sie verweist.
--terraform-plan-file-
Der relative oder absolute Pfad zu Ihrer lokalen Terraform Plandatei bei Verwendung der AWS SAM CLI mit Terraform Cloud. Für diese Option ist Folgendes erforderlich
--hook-namemuss gesetzt sein aufterraform. --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 den 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, sodass Sie Ihre Anwendung per API testen können. Damit dieser Befehl funktioniert, muss die Anwendung installiert sein und Docker muss ausgeführt werden.
$sam local start-api --port 3000