View a markdown version of this page

gleicher Build - AWS Serverless Application Model

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.

gleicher Build

Diese Seite enthält Referenzinformationen für AWS Serverless Application Model Befehlszeilenschnittstelle (AWS SAM CLI) sam build Befehl.

Das sam build Der Befehl bereitet eine Anwendung auf nachfolgende Schritte im Entwickler-Workflow vor, z. B. das lokale Testen oder die Bereitstellung auf dem AWS Cloud.

Wichtig

Lauf nicht sam build kein nicht vertrauenswürdiger Code. Der Befehl führt die vom Projekt definierten Build-Tools und Skripte, wie Makefile-Ziele, Paketmanager-Skripte und die Installation von Abhängigkeiten, in Ihrer lokalen Umgebung aus.

Usage

$ sam build <arguments> <options>

Argumente

Resource ID (Ressourcen-ID)

Optional. Instruktionen AWS SAM um eine einzelne Ressource zu erstellen, die in einer deklariert ist AWS SAM Muster. Die Build-Artefakte für die angegebene Ressource sind die einzigen, die für nachfolgende Befehle im Workflow verfügbar sind, d. h. sam package und sam deploy.

Optionen

--base-dir, -s DIRECTORY

Löst relative Pfade zum Quellcode der Funktion oder Ebene in Bezug auf dieses Verzeichnis auf. Verwenden Sie diese Option, wenn Sie ändern möchten, wie relative Pfade zu Quellcode-Ordnern aufgelöst werden. In der Standardeinstellung werden relative Pfade in Bezug auf AWS SAM der Speicherort der Vorlage.

Zusätzlich zu den Ressourcen in der Stammanwendung oder dem Stack, den Sie erstellen, bezieht sich diese Option auch auf verschachtelte Anwendungen oder Stacks.

Diese Option gilt für die folgenden Ressourcentypen und Eigenschaften:

  • Ressourcentyp: AWS::Serverless::Function Eigentum: CodeUri

  • Art der Ressource: AWS::Serverless::Function Ressourcenattribut: Metadata Eintrag: DockerContext

  • Art der Ressource: AWS::Serverless::LayerVersion Eigentum: ContentUri

  • Art der Ressource: AWS::Lambda::Function Eigentum: Code

  • Art der Ressource: AWS::Lambda::LayerVersion Eigentum: Content

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

Betafunktionen zulassen oder ablehnen.

--build-dir, -b DIRECTORY

Der Pfad zu einem Verzeichnis, in dem die erstellten Artefakte gespeichert sind. Dieses Verzeichnis und sein gesamter Inhalt werden mit dieser Option entfernt.

--build-image TEXT

Die URI des Container-Images, das Sie für den Build abrufen möchten. 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.

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 Ressourcen in Ihrer Anwendung verwendet werden soll. Beispiel, sam build --use-container --build-image amazon/aws-sam-cli-build-image-python3.8. 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. Zum Beispiel sam build --use-container --build-image Function1=amazon/aws-sam-cli-build-image-python3.8. Mit Schlüssel-Wert-Paaren können Sie verschiedene Container-Images für verschiedene Ressourcen angeben.

Diese Option gilt nur, wenn --use-container Die Option ist angegeben, andernfalls wird ein Fehler auftreten.

--build-in-source | --no-build-in-source

Bereitstellen --build-in-source um Ihr Projekt direkt im Quellordner zu erstellen.

Das --build-in-source Die Option unterstützt die folgenden Laufzeiten und Build-Methoden:

  • Laufzeiten — Irgendein Node.js Laufzeit, unterstützt von sam init --runtime Option.

  • Methoden erstellen — Makefile, esbuild.

Das --build-in-source Die Option ist nicht mit den folgenden Optionen kompatibel:

  • --hook-name

  • --use-container

Standardwert: --no-build-in-source

--cached | --no-cached

Aktiviert oder deaktiviert zwischengespeicherte Builds. Verwenden Sie diese Option, um Build-Artefakte wiederzuverwenden, die sich gegenüber früheren Builds nicht geändert haben. AWS SAM bewertet, ob Sie Dateien in Ihrem Projektverzeichnis geändert haben. Standardmäßig werden Builds nicht zwischengespeichert. Wenn der --no-cached Die Option wird aufgerufen, überschreibt sie die cached = true Einstellung in samconfig.toml.

Anmerkung

AWS SAM bewertet nicht, ob Sie Module von Drittanbietern geändert haben, von denen Ihr Projekt abhängt, für die Sie keine bestimmte Version bereitgestellt haben. Zum Beispiel, wenn Ihre Python-Funktion eine enthält requirements.txt Datei mit dem Eintrag requests=1.x, und die neueste Version des Anforderungsmoduls ändert sich von 1.1 zu 1.2, dann AWS SAM ruft die neueste Version erst ab, wenn Sie einen nicht zwischengespeicherten Build ausführen.

--cache-dir

Das Verzeichnis, in dem die Cache-Artefakte gespeichert werden, wenn --cached ist angegeben. Das Standard-Cache-Verzeichnis ist .aws-sam/cache.

--config-env TEXT

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

--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 SAMCLIKonfigurationsdatei.

--container-env-var, -e TEXT

Umgebungsvariablen, die an den Build-Container übergeben werden sollen. Sie können diese Option mehrfach angeben. Jede Instanz dieser Option verwendet ein Schlüssel-Wert-Paar, wobei der Schlüssel die Ressourcen- und Umgebungsvariable ist und der Wert der Wert der Umgebungsvariablen ist. Beispiel: --container-env-var Function1.GITHUB_TOKEN=TOKEN1 --container-env-var Function2.GITHUB_TOKEN=TOKEN2.

Diese Option gilt nur, wenn --use-container Die Option ist angegeben, andernfalls wird ein Fehler auftreten.

--container-env-var-file, -ef PATH

Der Pfad und der Dateiname einer JSON-Datei, die Werte für die Umgebungsvariablen des Containers enthält. Weitere Hinweise zu Container-Umgebungsvariablendateien finden Sie unter Datei mit Container-Umgebungsvariablen.

Diese Option gilt nur, wenn --use-container Die Option ist angegeben, andernfalls wird ein Fehler auftreten.

--debug

Schaltet die Debug-Protokollierung ein, um Debug-Meldungen auszudrucken, die AWS SAM CLI generiert und um Zeitstempel anzuzeigen.

--docker-network TEXT

Gibt den Namen oder die ID eines vorhandenen an Docker Netzwerk, das Lambda Docker Container sollten zusammen mit dem Standard-Bridge-Netzwerk eine Verbindung herstellen. Wenn nicht angegeben, stellen die Lambda-Container nur eine Verbindung zur Standard-Bridge her Docker Netzwerk.

--exclude, -x

Der Name der Ressource (n), die aus dem ausgeschlossen werden soll sam build. Zum Beispiel, wenn Ihre Vorlage Folgendes enthält Function1, Function2, und Function3 und du rennst sam build --exclude Function2, nur Function1 und Function3 wird gebaut.

--help

Zeigt diese Meldung an und beendet das Programm.

--hook-name TEXT

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

Zulässige Werte: terraform.

--manifest , -m PATH

Der Pfad zu einer benutzerdefinierten Abhängigkeitsmanifestdatei (z. B. package.json), die anstelle der Standarddatei verwendet werden soll.

Stellt sicher, dass AWS SAM CLI mountet immer Symlinks, die in den zu erstellenden oder aufzurufenden Dateien vorhanden sind. Dies gilt nur für Symlinks im Verzeichnis der obersten Ebene (d. h. für Symlinks, die sich direkt im Stammverzeichnis der Funktion befinden). Standardmäßig werden Symlinks nicht gemountet, außer denen, die zur Verwendung benötigt werden build-in-source zum node_modules in NodeJS.

--no-use-container

Eine Option, mit der Sie das IDE-Toolkit verwenden können, um das Standardverhalten festzulegen. Sie können auch verwenden sam build --no-use-container um einen Build auf Ihrem lokalen Computer anstelle eines Docker-Containers auszuführen.

--output [ text | json ]

Das Format der Befehlsausgabe:

  • text — Druckt normale, für Menschen lesbare Ausgaben. Dies ist der Standardwert.

  • json — Druckt eine strukturierte, maschinenlesbare Ausgabe. Verwenden Sie dieses Format, wenn Sie die Ausgabe programmgesteuert verarbeiten möchten, z. B. in CI/CD Pipelines, IDE-Erweiterungen und AI-assisted Werkzeuge.

Wenn Sie angeben --output json, der AWS SAM CLI druckt ein einzelnes JSON-Objekt, nachdem der Befehl abgeschlossen ist. Bei Erfolg enthält dieses Objekt Felder wie den Build-Status, das Build-Verzeichnis, die Vorlagendatei und eine Liste der Ressourcen, die erstellt wurden. Im Fehlerfall enthält es eine error Objekt, das beschreibt, was schief gelaufen ist.

--parallel

Aktiviert parallele Builds. Verwenden Sie diese Option, um Ihre zu erstellen AWS SAM Funktionen und Ebenen der Vorlage parallel. Standardmäßig werden die Funktionen und Ebenen nacheinander erstellt.

--parameter-overrides

(Optional) Eine Zeichenfolge, die Folgendes enthält CloudFormation Parameterüberschreibungen, die als Schlüssel-Wert-Paare kodiert sind. Verwendet dasselbe Format wie AWS Command Line Interface (AWS CLI). Zum Beispiel: 'ParameterKey=KeyPairName, ParameterValue=MyKey ParameterKey=InstanceType, ParameterValue=t1.micro'. Diese Option ist nicht kompatibel mit --hook-name.

--profile TEXT

Das spezifische Profil aus Ihrer Anmeldeinformationsdatei, das abgerufen wird AWS Anmeldeinformationen.

--region TEXT

Die AWS-Region zur Bereitstellung in. Beispiel: us-east-1.

--save-params

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

--skip-prepare-infra

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

--skip-pull-image

Gibt an, ob der Befehl das Herunterladen des neuesten Docker-Images für die Lambda-Laufzeit überspringen soll.

--template-file, --template, -t PATH

Der Pfad und der Dateiname von AWS SAM Vorlagendatei [default: template.[yaml|yml]]. Diese Option ist nicht kompatibel mit --hook-name.

--terraform-project-root-path

Der relative oder absolute Pfad zum Verzeichnis der obersten Ebene, das Ihre Terraform Konfigurationsdateien oder Funktionsquellcode. Wenn sich diese Dateien außerhalb des Verzeichnisses befinden, das Ihre enthält Terraform Root-Modul, verwenden Sie diese Option, um seinen absoluten oder relativen Pfad anzugeben. Für diese Option ist Folgendes erforderlich --hook-name muss gesetzt sein auf terraform.

--use-buildkit | --no-use-buildkit

Aktiviere oder deaktiviere mit dem BuildKit Plugin für Container-Image-Builds. Dies wird das verwenden Finch oder Docker CLIs. Standardmäßig verwendet Builds den Legacy-Builder aus dem SDK. Wenn der --no-use-buildkit Die Option wird aufgerufen, überschreibt sie die use-buildkit = true Einstellung in samconfig.toml.

--use-container, -u

Wenn Ihre Funktionen von Paketen abhängen, die nativ kompilierte Abhängigkeiten haben, verwenden Sie diese Option, um Ihre Funktion in einem Lambda-like Docker-Container.

Beispiel

Ein detailliertes Beispiel und eine ausführliche Anleitung zur Verwendung der sam build Unterbefehl finden Sie unter Einführung in das Bauen mit AWS SAM.