sam pipeline bootstrap - 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 pipeline bootstrap

Diese Seite enthält Referenzinformationen für den AWS Serverless Application Model sam local pipeline bootstrap Unterbefehl Command Line Interface (AWS SAMCLI).

Eine Einführung in das finden Sie AWS SAMCLI unter Was ist das? AWS SAMCLI

Der sam pipeline bootstrap Unterbefehl generiert die erforderlichen AWS Infrastrukturressourcen, um eine Verbindung zu Ihrem CI/CD-System herzustellen. Dieser Schritt muss für jede Bereitstellungsphase in Ihrer Pipeline ausgeführt werden, bevor der Befehl ausgeführt wird. sam pipeline init

Dieser Unterbefehl richtet die folgenden AWS Infrastrukturressourcen ein:

  • Option zur Konfiguration von Pipeline-Berechtigungen über:

  • Eine CloudFormation Ausführungs-IAM-Rolle, die CloudFormation zur Bereitstellung der Anwendung übernommen wurde. AWS SAM

  • Ein Amazon S3 S3-Bucket zur Aufbewahrung der AWS SAM Artefakte.

  • Optional ein Amazon ECR-Image-Repository für Lambda-Bereitstellungspakete für Container-Images (falls Sie über eine Ressource vom Typ Image Paket verfügen).

Usage

$ sam pipeline bootstrap <options>

Optionen

--bitbucket-repo-uuid TEXT

Die UUID des Bitbucket-Repositorys. Diese Option ist spezifisch für die Verwendung von Bitbucket OIDC für Berechtigungen.

Anmerkung

Dieser Wert ist unter https://bitbucket.org/workspace//-connect zu finden repository admin/addon/admin/pipelines/openid

--bucket TEXT

Der ARN des Amazon S3 S3-Buckets, der die AWS SAM Artefakte enthält.

--cicd-provider TEXT

Die CI/CD Plattform für die AWS SAM Pipeline.

--cloudformation-execution-role TEXT

Der ARN der IAM-Rolle, der CloudFormation bei der Bereitstellung des Anwendungsstapels übernommen werden soll. Geben Sie dies nur an, wenn Sie Ihre eigene Rolle verwenden möchten. Andernfalls erstellt der Befehl eine neue Rolle.

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

Fordern Sie auf, die Bereitstellung Ihrer Ressourcen zu bestätigen.

--create-image-repository | --no-create-image-repository

Geben Sie an, ob ein Amazon ECR-Image-Repository erstellt werden soll, falls keines bereitgestellt wird. Das Amazon ECR-Repository enthält die Container-Images von Lambda-Funktionen oder Ebenen mit dem Pakettyp. Image Der Standardwert ist --no-create-image-repository.

--debug

Aktiviert die Debug-Protokollierung und druckt die von ihm AWS SAMCLI generierten Debug-Nachrichten sowie die Anzeige von Zeitstempeln.

--deployment-branch TEXT

Name der Filiale, von der aus Bereitstellungen erfolgen. Diese Option ist spezifisch für die Verwendung von GitHub Actions OIDC für Berechtigungen.

--github-org TEXT

Die GitHub Organisation, zu der das Repository gehört. Wenn keine Organisation existiert, geben Sie den Benutzernamen des Repository-Besitzers ein. Diese Option ist spezifisch für die Verwendung von GitHub Actions OIDC für Berechtigungen.

--github-repo TEXT

Name des GitHub Repositorys, von dem aus Bereitstellungen erfolgen. Diese Option ist spezifisch für die Verwendung von GitHub Actions OIDC für Berechtigungen.

--gitlab-group TEXT

Die GitLab Gruppe, zu der das Repository gehört. Diese Option ist spezifisch für die Verwendung von GitLab OIDC für Berechtigungen.

--gitlab-project TEXT

Der GitLab Projektname. Diese Option ist spezifisch für die Verwendung von GitLab OIDC für Berechtigungen.

--help, -h

Zeigt diese Nachricht an und wird beendet.

--image-repository TEXT

Der ARN eines Amazon ECR-Image-Repositorys, das die Container-Images von Lambda-Funktionen oder Ebenen mit dem Pakettyp enthält. Image Falls angegeben, werden die --create-image-repository Optionen ignoriert. Falls nicht angegeben und --create-image-repository angegeben, erstellt der Befehl eine.

--interactive | --no-interactive

Deaktivieren Sie die interaktive Aufforderung für Bootstrap-Parameter und schlagen Sie fehl, wenn erforderliche Parameter fehlen. Der Standardwert ist --interactive. Für diesen Befehl --stage ist der einzige erforderliche Parameter.

Anmerkung

Wenn zusammen mit angegeben --no-interactive wird--use-oidc-provider, müssen alle erforderlichen Parameter für Ihren OIDC-Anbieter enthalten sein.

--oidc-client-id TEXT

Die Client-ID, die für die Verwendung mit Ihrem OIDC-Anbieter konfiguriert ist.

--oidc-provider [github-actions | gitlab | bitbucket-pipelines]

Name des CI/CD Anbieters, der für OIDC-Berechtigungen verwendet wird. GitLab GitHub, und Bitbucket werden unterstützt.

--oidc-provider-url TEXT

Die URL für den OIDC-Anbieter. Der Wert muss mit beginnen. https://

--permissions-provider [oidc | iam]

Wählen Sie einen Berechtigungsanbieter aus, der die Rolle der Pipeline-Ausführung übernehmen soll. Der Standardwert ist iam.

--pipeline-execution-role TEXT

Der ARN der IAM-Rolle, den der Pipeline-Benutzer annehmen muss, um in dieser Phase zu arbeiten. Geben Sie dies nur an, wenn Sie Ihre eigene Rolle verwenden möchten. Wenn nicht angegeben, erstellt dieser Befehl eine neue Rolle.

--pipeline-user TEXT

Der Amazon-Ressourcenname (ARN) des IAM-Benutzers, dessen Zugriffsschlüssel-ID und geheimer Zugriffsschlüssel mit dem CI/CD System geteilt werden. Er wird verwendet, um diesem IAM-Benutzer die Erlaubnis zu erteilen, auf das entsprechende AWS Konto zuzugreifen. Falls nicht angegeben, erstellt der Befehl einen IAM-Benutzer zusammen mit der Zugriffsschlüssel-ID und den Anmeldeinformationen für den geheimen Zugriffsschlüssel.

--profile TEXT

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

--region TEXT

Die AWS Region, in der die Bereitstellung erfolgen soll. Beispiel, us-east-1.

--save-params

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

--stage TEXT

Der Name der entsprechenden Bereitstellungsphase. Er wird als Suffix für die erstellten AWS Infrastrukturressourcen verwendet.

Fehlerbehebung

Fehler: Erforderlicher Parameter fehlt

Wenn zusammen mit angegeben --no-interactive wird --use-oidc-provider und keiner der erforderlichen Parameter angegeben wird, wird diese Fehlermeldung zusammen mit einer Beschreibung der fehlenden Parameter angezeigt.

Beispiel

Das folgende Beispiel erstellt die AWS Ressourcen, die für die Erstellung Ihres CI/CD Systems erforderlich sind, aktiviert die Debug-Protokollierung und druckt Debug-Meldungen, die generiert wurden von AWS SAMCLI: verwendet ein generiertes Ereignis für lokale Tests, indem ein Ereignis verwendet wird, um eine s3.json Lambda-Funktion lokal aufzurufen

$ sam pipeline bootstrap --debug