View a markdown version of this page

sam deploy - 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.

sam deploy

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

Das sam deploy Der Befehl stellt eine Anwendung auf dem bereit AWS Cloud unter Verwendung von AWS CloudFormation.

Wichtig

Lauf nicht sam deploy kein nicht vertrauenswürdiger Code. Der Befehl verwendet Ihre AWS Anmeldeinformationen zum Erstellen der Ressourcen, die die Vorlage definiert, einschließlich IAM-Rollen und -Richtlinien, und lädt die lokalen Dateien hoch, auf die die Vorlage verweist. Außerdem werden die Optionen in der Konfigurationsdatei des Projekts so angewendet, wie sie geschrieben wurden. Überprüfen Sie die Vorlage und die Konfigurationsdatei, bevor Sie ein Projekt bereitstellen, das Sie nicht selbst erstellt haben.

Usage

$ <environment variables> sam deploy <options>

Umgebungsvariablen

SAM_CLI_POLL_DELAY

Stellen Sie das ein SAM_CLI_POLL_DELAY Umgebungsvariable mit einem Wert von Sekunden in Ihrer Shell, um zu konfigurieren, wie oft AWS SAM CLI überprüft die CloudFormation Stack-Status, was nützlich ist, wenn Sie Drosselungen von sehen CloudFormation. Diese Umgebungsvariable wird für Abfragen verwendet describe_stack API-Aufrufe, die während der Ausführung getätigt werden sam deploy.

Das Folgende ist ein Beispiel für diese Variable:

$ SAM_CLI_POLL_DELAY=5 sam deploy

Optionen

--capabilities LIST

Eine Liste von Funktionen, die Sie angeben müssen, um sie zuzulassen CloudFormation um bestimmte Stapel zu erstellen. Einige Stack-Vorlagen enthalten möglicherweise Ressourcen, die sich auf Ihre Berechtigungen auswirken AWS-Konto, zum Beispiel durch das Erstellen neuer AWS Identity and Access Management (IAM) -Benutzer. Für diese Stacks müssen Sie ihre Fähigkeiten explizit bestätigen, indem Sie diese Option angeben. Die einzigen gültigen Werte sind CAPABILITY_IAM und CAPABILITY_NAMED_IAM. Wenn Sie über IAM-Ressourcen verfügen, können Sie beide Funktionen angeben. Wenn Sie IAM-Ressourcen mit benutzerdefinierten Namen haben, müssen Sie Folgendes angeben CAPABILITY_NAMED_IAM. Wenn Sie diese Option nicht angeben, gibt die Operation eine InsufficientCapabilities Fehler.

Wenn Sie eine Anwendung bereitstellen, die verschachtelte Anwendungen enthält, müssen Sie CAPABILITY_AUTO_EXPAND um zu bestätigen, dass die Anwendung verschachtelte Anwendungen enthält. Weitere Informationen finden Sie unter Bereitstellen verschachtelter Anwendungen.

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

--confirm-changeset | --no-confirm-changeset

Aufforderung zur Bestätigung, ob AWS SAM CLI stellt das berechnete Changeset bereit.

--debug

Schalten Sie die Debug-Protokollierung ein, um die Debug-Meldung auszudrucken, die AWS SAM CLI generiert Zeitstempel und zeigt sie an.

--disable-rollback | --no-disable-rollback

Geben Sie an, ob Sie Ihr rückgängig machen möchten CloudFormation Stapel, wenn während einer Bereitstellung ein Fehler auftritt. Wenn während einer Bereitstellung ein Fehler auftritt, wird Ihr CloudFormation Stack wird in den letzten stabilen Zustand zurückgesetzt. Wenn Sie angeben --disable-rollback und während einer Bereitstellung ein Fehler auftritt, werden Ressourcen, die vor dem Auftreten des Fehlers erstellt oder aktualisiert wurden, nicht zurückgesetzt.

--express | --no-express

Gibt an, ob verwendet werden soll CloudFormation Express-Modus. Wenn diese Option aktiv ist, werden die Stapeloperationen abgeschlossen, sobald die Ressourcenkonfiguration angewendet wurde. Die Ressourcen werden weiterhin im Hintergrund bereit gestellt. Die Bereitstellungszeit kann um das bis zu 4-fache reduziert werden.

Das AWS SAM CLI übergibt das Rollback-Verhalten an den CloudFormation DeploymentConfig Parameter, wenn Sie auch angeben --disable-rollback.

Der Standardwert ist --no-express.

--fail-on-empty-changeset | --no-fail-on-empty-changeset

Geben Sie an, ob ein Exit-Code ungleich Null zurückgegeben werden soll, wenn keine Änderungen am Stack vorgenommen werden müssen. Das Standardverhalten besteht darin, einen Exitcode ungleich Null zurückzugeben.

--force-upload

Geben Sie diese Option an, um Artefakte hochzuladen, auch wenn sie mit vorhandenen Artefakten im Amazon S3-Bucket übereinstimmen. Passende Artefakte werden überschrieben.

--guided, -g

Geben Sie diese Option an, um AWS SAM CLI verwenden Sie Eingabeaufforderungen, um Sie durch die Bereitstellung zu führen.

--help

Diese Meldung anzeigen und das Programm beenden.

--image-repositories TEXT

Eine Zuordnung von Funktionen zu ihrer Amazon ECR-Repository-URI. Referenzfunktionen anhand ihrer logischen ID. Im Folgenden wird ein Beispiel gezeigt:

$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo

Sie können diese Option mehrmals in einem einzigen Befehl angeben.

--image-repository TEXT

Der Name des Amazon ECR-Repositorys, in das dieser Befehl das Bild Ihrer Funktion hochlädt. Diese Option ist für Funktionen erforderlich, die mit dem Image Pakettyp.

--kms-key-id TEXT

Die ID eines AWS Key Management Service (AWS KMS) Schlüssel, der zum Verschlüsseln von Artefakten verwendet wird, die sich im Amazon S3-Bucket befinden. Wenn Sie diese Option nicht angeben, dann AWS SAM verwendet Amazon S3-managed Verschlüsselungsschlüssel.

Für einen AWS::Serverless::WebFunction in den Bucket hochgeladen, den Sie mit angeben --s3-bucket, der Schlüssel muss ein vom Kunden verwalteter Schlüssel sein, dessen Schlüsselrichtlinie dies zulässt lambda.amazonaws.com anrufen kms:Decrypt.

--metadata

Eine Karte mit Metadaten, die an alle Artefakte angehängt werden können, auf die in Ihrer Vorlage verwiesen wird.

--no-execute-changeset

Gibt an, ob das Changeset angewendet werden soll. Geben Sie diese Option an, wenn Sie Ihre Stack-Änderungen sehen möchten, bevor Sie das Changeset anwenden. Dieser Befehl erstellt eine CloudFormation Changeset und wird dann beendet, ohne das Changeset anzuwenden. Um das Changeset anzuwenden, führen Sie denselben Befehl ohne diese Option aus.

--no-progressbar

Zeigen Sie keine Fortschrittsleiste an, wenn Sie Artefakte auf Amazon S3 hochladen.

--notification-arns LIST

Eine Liste der thematischen ARNs von Amazon Simple Notification Service (Amazon SNS), die CloudFormation verknüpft sich mit dem Stack.

--on-failure [ROLLBACK | DELETE | DO_NOTHING]

Geben Sie die Aktion an, die ausgeführt werden soll, wenn ein Stapel nicht erstellt werden kann.

Die folgenden Optionen sind verfügbar:

  • ROLLBACK — Setzt den Stack auf einen früheren als funktionierend bekannten Zustand zurück.

  • DELETE — Setzt den Stapel auf einen früheren als funktionierend bekannten Zustand zurück, falls ein solcher vorhanden ist. Andernfalls wird der Stapel gelöscht.

  • DO_NOTHING — Der Stapel wird weder zurückgesetzt noch gelöscht. Der Effekt ist der gleiche wie der von --disable-rollback.

Das Standardverhalten ist ROLLBACK.

Anmerkung

Sie können entweder angeben --disable-rollback Option oder --on-failure Option, aber nicht beides.

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

Eine Bereitstellung läuft über einen bestimmten Zeitraum. Wenn Sie angeben --output json, der AWS SAM CLI druckt einen Stream von JSON-Objekten, eines pro Zeile, während die Bereitstellung voranschreitet. Jedes Objekt enthält eine type Feld, das die Art der darin enthaltenen Informationen identifiziert, z. B. den Changeset, Bereitstellungsereignisse, Stack-Ausgaben und das Endergebnis. Bei einem Ausfall enthält das endgültige Objekt eine error Objekt, das beschreibt, was schief gelaufen ist.

Anmerkung

Das --output json Die Option ist nicht kompatibel mit Optionen, die interaktive Eingabeaufforderungen erfordern, wie --guided und --confirm-changeset.

--parameter-overrides LIST

Eine Zeichenfolge, die enthält CloudFormation Parameterüberschreibungen, die als Schlüssel-Wert-Paare kodiert sind. Jede Überschreibung verwendet das Format ParameterKey=name,ParameterValue=value. Mehrere Überschreibungen werden durch Leerzeichen getrennt. Nachfolgend finden Sie zwei Beispiele:

$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2
$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana
--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.

--resolve-image-repos

Erstellen Sie automatisch Amazon ECR-Repositorys, die Sie für das Paketieren und Bereitstellen von Bereitstellungen ohne Anleitung verwenden können. Diese Option gilt nur für Funktionen und Ebenen mit PackageType: Image spezifiziert. Wenn Sie den angeben --guided Option, dann AWS SAM CLI ignoriert --resolve-image-repos.

Anmerkung

Wenn AWS SAM erstellt mit dieser Option automatisch alle Amazon ECR-Repositorys für Funktionen oder Ebenen. Später löschen Sie diese Funktionen oder Ebenen aus Ihrem AWS SAM Vorlage, dann werden die entsprechenden Amazon ECR-Repositorys automatisch gelöscht.

--resolve-s3

Erstellen Sie automatisch einen Amazon S3-Bucket, den Sie für die Paketierung und Bereitstellung für Bereitstellungen ohne Anleitung verwenden können. Wenn Sie den angeben --guided Option, dann AWS SAM CLI ignoriert --resolve-s3. Wenn Sie beide angeben --s3-bucket und --resolve-s3 Optionen, dann tritt ein Fehler auf.

Mit dieser Option oder --guided, der Code eines AWS::Serverless::WebFunction wird in einen Code-Bucket hochgeladen, der zum Stack gehört, nicht zum verwalteten Bucket. Weitere Informationen finden Sie unter Erstellen und Bereitstellen von Lambda-Webfunktionen.

--role-arn TEXT

Der Amazon-Ressourcenname (ARN) einer IAM-Rolle CloudFormation nimmt bei der Anwendung des Changesets an.

--s3-bucket TEXT

Der Name des Amazon S3-Buckets, in den dieser Befehl Ihren hochlädt CloudFormation Vorlage. Wenn Ihre Vorlage größer als 51.200 Byte ist, dann entweder --s3-bucket Option oder --resolve-s3 Option ist erforderlich. Wenn Sie beide angeben --s3-bucket und --resolve-s3 Optionen, dann tritt ein Fehler auf.

Der Code eines AWS::Serverless::WebFunction wird auch in diesen Bucket hochgeladen, für den die Versionierung aktiviert sein muss, damit Lambda den Code lesen kann. Weitere Informationen finden Sie unter Erstellen und Bereitstellen von Lambda-Webfunktionen.

--s3-prefix TEXT

Das Präfix, das den Namen der Artefakte hinzugefügt wird, die in den Amazon S3-Bucket hochgeladen werden. Der Präfixname ist ein Pfadname (Ordnername) für den Amazon S3-Bucket.

--save-params

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

--signing-profiles LIST

Die Liste der Signaturprofile, mit denen Sie Ihre Bereitstellungspakete signieren können. Diese Option verwendet eine Liste von Schlüssel-Wert-Paaren, wobei der Schlüssel der Name der Funktion oder Ebene ist, die signiert werden soll, und der Wert das Signaturprofil ist. Ein optionaler Profilbesitzer ist abgegrenzt durch :. Beispiel, FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner.

--stack-name TEXT

(Erforderlich) Der Name des CloudFormation Stapel, auf dem Sie die Bereitstellung durchführen. Wenn Sie einen vorhandenen Stack angeben, aktualisiert der Befehl den Stack. Wenn Sie einen neuen Stapel angeben, wird er mit dem Befehl erstellt.

--tags LIST

Eine Liste von Tags, die dem Stapel zugeordnet werden sollen, der erstellt oder aktualisiert wird. CloudFormation gibt diese Tags auch an Ressourcen im Stack weiter, die sie unterstützen.

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

Der Pfad und der Dateiname, in dem Ihr AWS SAM Die Vorlage befindet sich.

Anmerkung

Wenn Sie diese Option angeben, dann AWS SAM stellt nur die Vorlage und die lokalen Ressourcen bereit, auf die sie verweist.

--use-json

Geben Sie JSON für das aus CloudFormation Vorlage. Die Standardausgabe ist YAML.

Beispiel

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