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 den finden AWS SAMCLI Sie unterWas ist das? AWS SAMCLI.

• Eine Dokumentation zur Verwendung des AWS SAMCLI sam deploy Befehls finden Sie unterEinführung in die Bereitstellung mit AWS SAM.

Der sam deploy Befehl stellt eine Anwendung für den AWS Cloud Benutzer bereit. AWS CloudFormation

Verwendung

$ <environment variables> sam deploy <options>

Umgebungsvariablen

SAM_CLI_POLL_DELAY

Setzen Sie die SAM_CLI_POLL_DELAY Umgebungsvariable auf einen Wert von Sekunden, um zu konfigurieren, wie oft die AWS SAM-CLI den AWS CloudFormation Stack-Status überprüft. Dies ist nützlich, wenn Drosselung von angezeigt wird. AWS CloudFormation Diese Umgebungsvariable wird für die Abfrage von describe_stack API-Aufrufen verwendet, die während der Ausführung ausgeführt werden. sam deploy

Im Folgenden finden Sie 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 die Erstellung bestimmter Stacks AWS 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 AWS Identity and Access Management (IAM-) Benutzer. Bei diesen Stacks müssen Sie ihre Fähigkeiten ausdrücklich anerkennen, 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 eine der beiden Funktionen angeben. Wenn Sie über IAM-Ressourcen mit benutzerdefinierten Namen verfügen, müssen Sie Folgendes angeben. CAPABILITY_NAMED_IAM Wenn Sie diese Option nicht angeben, gibt der Vorgang einen InsufficientCapabilities Fehler zurück.

--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 befindet sich samconfig.toml im Stammverzeichnis des Projektverzeichnisses. Weitere Informationen zu Konfigurationsdateien finden Sie unter AWS SAMCLIKonfigurationsdatei.

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

Fordert auf, zu bestätigen, ob der den berechneten Changeset AWS SAMCLI bereitstellt.

--debug

Aktivieren Sie die Debug-Protokollierung, um die generierte Debug-Nachricht zu drucken und Zeitstempel anzuzeigen. AWS SAMCLI

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

Geben Sie an, ob Ihr AWS CloudFormation Stack zurückgesetzt werden soll, falls während einer Bereitstellung ein Fehler auftritt. Wenn während einer Bereitstellung ein Fehler auftritt, wird Ihr AWS CloudFormation Stack standardmäßig auf den letzten stabilen Status 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.

--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 Exit-Code ungleich Null zurückzugeben.

--force-upload

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

--guided, -g

Geben Sie diese Option an, damit AWS SAMCLI Sie von den Benutzeraufforderungen durch die Bereitstellung geführt werden.

--help

Diese Meldung anzeigen und 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 in einem einzigen Befehl mehrfach 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 deklariert wurden.

--kms-key-id TEXT

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

--metadata

Eine Metadatenübersicht, die an alle Artefakte angehängt werden kann, 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 anzeigen möchten, bevor Sie das Changeset anwenden. Dieser Befehl erstellt ein AWS 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 keinen Fortschrittsbalken an, wenn Sie Artefakte auf Amazon S3 hochladen.

--notification-arns LIST

Eine Liste der Themen-ARNs von Amazon Simple Notification Service (Amazon SNS), die dem AWS CloudFormation Stack 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.

Verfügbar sind die nachfolgend aufgeführten Optionen:

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

• DELETE— Bringt den Stack in einen früheren als funktionierend bekannten Zustand zurück, falls einer existiert. Andernfalls wird der Stapel gelöscht.

• DO_NOTHING— Macht den Stapel weder rückgängig noch löscht er ihn. Der Effekt ist derselbe wie der von. --disable-rollback

Das Standardverhalten ist ROLLBACK.

Anmerkung

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

--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 z. B. ParameterKey=ParameterValue InstanceType=t1.micro.

--profile TEXT

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

--region TEXT

Das AWS-Region , in dem die Bereitstellung erfolgen soll. Beispiel: us-east-1.

--resolve-image-repos

Erstellen Sie automatisch Amazon ECR-Repositorys, die für die Paketierung und Bereitstellung für Bereitstellungen ohne Anleitung verwendet werden. Diese Option gilt nur für Funktionen und Ebenen mit den angegebenen Werten. PackageType: Image Wenn Sie die --guided Option 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 S3-Bucket, der für die Paketierung und Bereitstellung bei Bereitstellungen ohne Anleitung verwendet wird. Wenn Sie die --guided Option angeben, ignoriert die AWS SAM CLI sie--resolve-s3. Wenn Sie sowohl die --s3-bucket --resolve-s3 Optionen als auch angeben, tritt ein Fehler auf.

--role-arn TEXT

Der Amazon-Ressourcenname (ARN) einer IAM-Rolle, der beim Anwenden des Changesets übernommen AWS CloudFormation wird.

--s3-bucket TEXT

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

--s3-prefix TEXT

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

--save-params

Speichern Sie die Parameter, die Sie in der Befehlszeile angeben, in der 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, wobei der optionale Profilbesitzer durch getrennt ist. : z. B. FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner.

--stack-name TEXT

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

--tags LIST

Eine Liste von Tags, die dem erstellten oder aktualisierten Stapel zugeordnet werden sollen. AWS CloudFormation leitet diese Tags auch an Ressourcen im Stack weiter, die sie unterstützen.

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

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 AWS CloudFormation Vorlage aus. Die Standardausgabe ist YAML.