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 den AWS Serverless Application Model Befehl Command Line Interface (AWS SAMCLI)sam deploy.
-
Eine Einführung in das finden AWS SAMCLI Sie unter Was ist der AWS SAM CLI?
-
Eine Dokumentation zur Verwendung des AWS SAMCLI
sam deployBefehls finden Sie unterEinführung in die Bereitstellung mit AWS SAM.
Der sam deploy Befehl stellt dem Benutzer eine AWS Cloud Anwendung AWS CloudFormation zur Verfügung.
Usage
$<environment variables>sam deploy<options>
Umgebungsvariablen
SAM_CLI_POLL_DELAY-
Stellen Sie in Ihrer Shell die
SAM_CLI_POLL_DELAYUmgebungsvariable auf einen Wert von Sekunden ein, um zu konfigurieren, wie oft die AWS SAM-CLI den CloudFormation Stack-Status überprüft. Dies ist nützlich, wenn Sie Drosselungen von sehen. CloudFormation Diese Umgebungsvariable wird für die Abfrage vondescribe_stackAPI-Aufrufen verwendet, die während der Ausführung getätigt werden.sam deployDas Folgende ist ein Beispiel für diese Variable:
$SAM_CLI_POLL_DELAY=5sam deploy
Optionen
--capabilitiesLIST-
Eine Liste von Funktionen, die Sie angeben müssen, um das Erstellen bestimmter Stacks CloudFormation zu ermöglichen. Einige Stack-Vorlagen können Ressourcen enthalten, die sich auf Ihre Berechtigungen auswirken AWS-Konto, z. B. durch das Erstellen neuer Benutzer AWS Identity and Access Management (IAM). Für diese Stacks müssen Sie deren Funktionen explizit bestätigen, indem Sie diese Option angeben. Die einzigen gültigen Werte sind
CAPABILITY_IAMundCAPABILITY_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_IAMWenn Sie diese Option nicht angeben, gibt der Vorgang einenInsufficientCapabilitiesFehler zurück.Wenn Sie eine Anwendung bereitstellen, die verschachtelte Anwendungen enthält, müssen Sie bestätigen, dass
CAPABILITY_AUTO_EXPANDdie Anwendung verschachtelte Anwendungen enthält. Weitere Informationen finden Sie unter Bereitstellen verschachtelter Anwendungen. --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 befindet sich
samconfig.tomlim Stammverzeichnis des Projektverzeichnisses. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAMCLIKonfigurationsdatei. --confirm-changeset | --no-confirm-changeset-
Sie werden aufgefordert, zu bestätigen, ob das AWS SAMCLI berechnete Changeset bereitgestellt wird.
--debug-
Schalten Sie die Debug-Protokollierung ein, um die AWS SAMCLI generierte Debug-Meldung auszudrucken und Zeitstempel anzuzeigen.
--disable-rollback | --no-disable-rollback-
Geben Sie an, ob Ihr CloudFormation Stack zurückgesetzt werden soll, wenn während einer Bereitstellung ein Fehler auftritt. Wenn während einer Bereitstellung ein Fehler auftritt, wird Ihr CloudFormation Stack standardmäßig in den letzten stabilen Zustand zurückgesetzt. Wenn Sie angeben
--disable-rollbackund 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 der CloudFormation Expressmodus verwendet werden soll. Wenn diese Option aktiviert ist, werden die Stapelvorgänge 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.
Der AWS SAMCLI übergibt das Rollback-Verhalten an den CloudFormation
DeploymentConfigParameter, wenn Sie es ebenfalls 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, damit die AWS SAMCLI Benutzeranweisungen Sie durch die Bereitstellung führen.
--help-
Diese Meldung anzeigen und das Programm beenden.
--image-repositoriesTEXT-
Eine Zuordnung von Funktionen zu ihrer Amazon ECR-Repository-URI. Referenzfunktionen anhand ihrer logischen ID. Im Folgenden wird ein Beispiel gezeigt:
$sam deploy --image-repositoriesFunction1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repoSie können diese Option mehrmals in einem einzigen Befehl angeben.
--image-repositoryTEXT-
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
ImagePakettyp deklariert wurden. --kms-key-idTEXT-
Die ID eines AWS Key Management Service (AWS KMS) -Schlüssels, der zum Verschlüsseln von Artefakten verwendet wird, die sich im Amazon S3-Bucket befinden. Wenn Sie diese Option nicht angeben, werden S3-managed Amazon-Verschlüsselungsschlüssel AWS SAM verwendet.
--metadata-
Eine Karte mit Metadaten, die an alle Artefakte angehängt werden, 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 ein 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-arnsLIST-
Eine Liste der thematischen ARNs von Amazon Simple Notification Service (Amazon SNS), die dem Stack CloudFormation zugeordnet sind.
--on-failure [ROLLBACK | DELETE | DO_NOTHING]-
Geben Sie die Aktion an, die ausgeführt werden soll, wenn ein Stack 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 die
--disable-rollbackOption oder die--on-failureOption angeben, aber nicht beide. -
--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 verwenden möchten, z. B. in CI/CD Pipelines, IDE-Erweiterungen und Tools. AI-assisted
Eine Bereitstellung läuft über einen bestimmten Zeitraum. Wenn Sie angeben
--output json, AWS SAMCLI druckt das im Verlauf der Bereitstellung einen Stream von JSON-Objekten, eines pro Zeile. Jedes Objekt enthält eintypeFeld, das die Art der darin enthaltenen Informationen identifiziert, z. B. den Changeset, Bereitstellungsereignisse, Stack-Ausgaben und das Endergebnis. Im Fehlerfall enthält das endgültige Objekt einerrorObjekt, das beschreibt, was schief gelaufen ist.Anmerkung
Die
--output jsonOption ist nicht mit Optionen kompatibel, die interaktive Eingabeaufforderungen erfordern, wie z. B.--guidedund--confirm-changeset. -
--parameter-overridesLIST-
Eine Zeichenfolge, die CloudFormation Parameterüberschreibungen enthält, die als Schlüssel-Wert-Paare kodiert sind. Bei jeder Überschreibung wird das Format verwendet.
ParameterKey=name,ParameterValue=valueMehrere Überschreibungen werden durch Leerzeichen getrennt. Nachfolgend finden Sie zwei Beispiele:$sam deploy --parameter-overridesParameterKey=value1,ParameterValue=value2$sam deploy --parameter-overridesParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana --profileTEXT-
Das spezifische Profil aus Ihrer Anmeldeinformationsdatei, das Anmeldeinformationen abruft AWS .
--regionTEXT-
Das AWS-Region , für das die Bereitstellung erfolgen soll. 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 Angabe.
PackageType: ImageWenn Sie die--guidedOption angeben, wird sie AWS SAMCLI ignoriert--resolve-image-repos.Anmerkung
Wenn mit dieser Option AWS SAM automatisch Amazon ECR-Repositorys für Funktionen oder Ebenen erstellt werden und Sie diese Funktionen oder Ebenen später aus Ihrer AWS SAM Vorlage löschen, 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 nicht geführte Bereitstellungen verwenden können. Wenn Sie die
--guidedOption angeben, wird sie von der AWS SAM CLI ignoriert.--resolve-s3Wenn Sie sowohl die--s3-bucket--resolve-s3Optionen als auch angeben, tritt ein Fehler auf. --role-arnTEXT-
Der Amazon-Ressourcenname (ARN) einer IAM-Rolle, die bei der Anwendung des Changesets übernommen CloudFormation wird.
--s3-bucketTEXT-
Der Name des Amazon S3-Buckets, in den dieser Befehl Ihre Vorlage hochlädt. CloudFormation Wenn Ihre Vorlage größer als 51.200 Byte ist, ist entweder die
--s3-bucketOption oder die--resolve-s3Option erforderlich. Wenn Sie sowohl die--s3-bucket--resolve-s3Optionen als auch angeben, tritt ein Fehler auf. --s3-prefixTEXT-
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, in der AWS SAM Konfigurationsdatei.
--signing-profilesLIST-
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, wobei ein optionaler Profilbesitzer durch getrennt ist.
:Beispiel,FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner. --stack-nameTEXT-
(Erforderlich) Der Name des CloudFormation Stacks, 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.
-
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, -tPATH-
Der Pfad und der Dateiname, in dem sich Ihre AWS SAM Vorlage befindet.
Anmerkung
Wenn Sie diese Option angeben, werden AWS SAM nur die Vorlage und die lokalen Ressourcen bereitgestellt, auf die sie verweist.
--use-json-
Gibt JSON für die CloudFormation Vorlage aus. Die Standardausgabe ist YAML.
Beispiel
Ein detailliertes Beispiel und eine ausführliche Anleitung zur Verwendung des sam deploy Unterbefehls finden Sie unter. Einführung in die Bereitstellung mit AWS SAM