cdk bootstrap - AWS Cloud Development Kit (AWS CDK) v2

Dies ist der AWS CDK v2-Entwicklerhandbuch. Die ältere CDK Version 1 wurde am 1. Juni 2022 in die Wartung aufgenommen und der Support wurde am 1. Juni 2023 eingestellt.

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.

cdk bootstrap

Bereiten Sie eine AWS Umgebung für CDK Bereitstellungen vor, indem Sie den CDK Bootstrap-Stack (genanntCDKToolkit) in der Umgebung bereitstellen. AWS

Der Bootstrap-Stack ist ein CloudFormation Stack, der einen Amazon S3 S3-Bucket und ein ECR Amazon-Repository in der AWS Umgebung bereitstellt. The AWS CDK CLI verwendet diese Ressourcen, um synthetisierte Vorlagen und zugehörige Ressourcen während der Bereitstellung zu speichern.

Verwendung

$ cdk bootstrap <arguments> <options>

Argumente

AWS Umgebung

Die AWS Zielumgebung, in der der Bootstrap-Stack bereitgestellt werden soll, im folgenden Format:aws://<account-id>/<region>.

Beispiel: aws://123456789012/us-east-1

Dieses Argument kann in einem einzigen Befehl mehrmals angegeben werden, um den Bootstrap-Stack in mehreren Umgebungen bereitzustellen.

Standardmäßig bootet das CDK CLI alle Umgebungen, auf die in der CDK App verwiesen wird, oder bestimmt eine Umgebung aus Standardquellen. Dies kann eine Umgebung sein, die mit der --profile Option angegeben wurde, aus Umgebungsvariablen oder AWS CLI Standardquellen.

Optionen

Eine Liste der globalen Optionen, die mit allen CDK CLI Befehlen funktionieren, finden Sie unterGlobale Optionen.

--bootstrap-bucket-name, --toolkit-bucket-name, -b STRING

Der Name des Amazon S3 S3-Buckets, der von der verwendet wird CDKCLI. Dieser Bucket wird erstellt und darf derzeit nicht existieren.

Geben Sie diese Option an, um den Standardnamen des Amazon S3 S3-Buckets zu überschreiben.

Wenn Sie diese Option verwenden, müssen Sie die Synthese möglicherweise anpassen. Weitere Informationen hierzu finden Sie unter Passen Sie die Stacksynthese an CDK.

Standardwert: Undefiniert

--bootstrap-customer-key BOOLEAN

Erstellen Sie einen Kundenhauptschlüssel (CMK) für den Bootstrap-Bucket (es wird Ihnen eine Gebühr berechnet, Sie können jedoch die Berechtigungen anpassen, nur modernes Bootstrapping).

Diese Option ist nicht kompatibel mit. --bootstrap-kms-key-id

Standardwert: Undefiniert

--bootstrap-kms-key-id STRING

Die AWS KMS Master-Key-ID, die für die SSE-KMS Verschlüsselung verwendet werden soll.

Stellen Sie diese Option bereit, um den AWS KMS Standardschlüssel zu überschreiben, der zum Verschlüsseln des Amazon S3 S3-Buckets verwendet wird.

Diese Option ist nicht kompatibel mit--bootstrap-customer-key.

Standardwert: Undefiniert

--cloudformation-execution-policies ARRAY

Die verwaltete IAM RichtlinieARNs, die der Bereitstellungsrolle zugewiesen werden sollte, die bei AWS CloudFormation der Bereitstellung Ihrer Stacks übernommen wurde.

Standardmäßig werden Stacks mithilfe der Richtlinie mit vollen Administratorrechten bereitgestellt. AdministratorAccess

Sie können diese Option in einem einzigen Befehl mehrfach angeben. Sie können ARNs auch mehrere in einer einzigen Zeichenfolge angeben, wobei die einzelnen durch Kommas ARNs getrennt werden. Im Folgenden wird ein Beispiel gezeigt:

$ cdk bootstrap --cloudformation-execution-policies "arn:aws:iam::aws:policy/AWSLambda_FullAccess,arn:aws:iam::aws:policy/AWSCodeDeployFullAccess"

Um Bereitstellungsfehler zu vermeiden, stellen Sie sicher, dass die von Ihnen angegebenen Richtlinien für alle Bereitstellungen, die Sie in der Umgebung durchführen, für die das Bootstrapping ausgeführt wird, ausreichend sind.

Diese Option gilt nur für modernes Bootstrapping.

Wichtig

Die moderne Bootstrap-Vorlage gewährt praktisch jedem AWS Konto in der Liste die in der --cloudformation-execution-policies Liste enthaltenen Berechtigungen. --trust Standardmäßig werden dadurch die Lese- und Schreibberechtigungen für alle Ressourcen im Bootstrap-Konto erweitert. Stellen Sie sicher, dass Sie den Bootstrapping-Stack mit Richtlinien und vertrauenswürdigen Konten konfigurieren, mit denen Sie vertraut sind.

Standardwert: []

--custom-permissions-boundary, -cpb STRING

Geben Sie den Namen einer zu verwendenden Berechtigungsgrenze an.

Diese Option ist nicht kompatibel mit--example-permissions-boundary.

Standardwert: Undefiniert

--example-permissions-boundary, -epb BOOLEAN

Verwenden Sie das Beispiel für die Berechtigungsgrenze, die von der AWS CDK bereitgestellt wird.

Diese Option ist nicht kompatibel mit--custom-permissions-boundary.

Die CDK mitgelieferte Grenzrichtlinie für Berechtigungen sollte als Beispiel betrachtet werden. Bearbeiten Sie den Inhalt und verweisen Sie auf die Beispielrichtlinie, wenn Sie die Funktion testen. Wandeln Sie sie in eine neue Richtlinie für tatsächliche Bereitstellungen um, falls noch keine vorhanden ist. Es geht darum, Abweichungen zu vermeiden. Höchstwahrscheinlich wird eine Rechtegrenze beibehalten und es gibt spezielle Konventionen, einschließlich der Benennung.

Weitere Informationen zur Konfiguration von Berechtigungen, einschließlich der Verwendung von Rechtegrenzen, finden Sie im Security and Safety Dev Guide.

Standardwert: Undefiniert

--execute BOOLEAN

Konfigurieren Sie, ob der Änderungssatz ausgeführt werden soll.

Standardwert: true

--force, -f BOOLEAN

Führen Sie immer Bootstrap durch, auch wenn dadurch die Bootstrap-Vorlagenversion herabgestuft würde.

Standardwert: false

--help, -h BOOLEAN

Zeigt die Befehlsreferenzinformationen für den Befehl an. cdk bootstrap

--previous-parameters BOOLEAN

Verwenden Sie vorherige Werte für vorhandene Parameter.

Sobald eine Bootstrap-Vorlage mit einer Reihe von Parametern bereitgestellt wurde, müssen Sie diese Option auf setzen, false um alle Parameter bei future Bereitstellungen zu ändern. Wennfalse, müssen Sie alle zuvor angegebenen Parameter erneut angeben.

Standardwert: true

--public-access-block-configuration BOOLEAN

Blockieren Sie die öffentliche Zugriffskonfiguration für den Amazon S3 S3-Bucket, der von erstellt und verwendet wird CDKCLI.

Standardwert: true

--qualifier STRING

Neunstelliger Zeichenkettenwert, der für jeden Bootstrap-Stack eindeutig ist. Dieser Wert wird zur physischen ID der Ressourcen im Bootstrap-Stack hinzugefügt.

Durch die Bereitstellung eines Qualifizierers vermeiden Sie Konflikte bei Ressourcennamen, wenn Sie mehrere Bootstrap-Stacks in derselben Umgebung bereitstellen.

Wenn Sie den Qualifier ändern, muss Ihre CDK App den geänderten Wert an den Stack-Synthesizer übergeben. Weitere Informationen finden Sie unter Passen Sie die Stacksynthese an CDK.

Standardwert: hnb659fds. Dieser Wert hat keine Bedeutung.

--show-template BOOLEAN

Anstatt Bootstrapping durchzuführen, drucken Sie die aktuelle Bootstrap-Vorlage auf die Standardausgabe (). stdout Anschließend können Sie die Vorlage kopieren und nach Bedarf anpassen.

Standardwert: false

--tags, -t ARRAY

Tags, die dem Bootstrap-Stack hinzugefügt werden sollen, im Format vonKEY=VALUE.

Standardwert: []

--template STRING

Verwenden Sie die Vorlage aus der angegebenen Datei anstelle der integrierten.

--termination-protection BOOLEAN

Schalten Sie den AWS CloudFormation Terminierungsschutz auf dem Bootstrap-Stack um.

Wann ist true der Kündigungsschutz aktiviert. Dadurch wird verhindert, dass der Bootstrap-Stack versehentlich gelöscht wird.

Weitere Informationen zum Kündigungsschutz finden Sie im AWS CloudFormation Benutzerhandbuch unter Einen Stack vor dem Löschen schützen.

Standardwert: Undefiniert

--toolkit-stack-name STRING

Der Name des zu erstellenden Bootstrap-Stacks.

cdk bootstrapStellt standardmäßig einen Stack mit dem Namen CDKToolkit in der angegebenen AWS Umgebung bereit. Verwenden Sie diese Option, um einen anderen Namen für Ihren Bootstrap-Stack anzugeben.

Standardwert: CDKToolkit

Erforderlich: Ja

--trust ARRAY

Derjenige AWS-Konto IDs, dem bei der Durchführung von Bereitstellungen in dieser Umgebung vertraut werden sollte.

Dem Konto, das das Bootstrapping durchführt, wird immer vertraut.

Diese Option erfordert, dass Sie auch Folgendes angeben. --cloudformation-execution-policies

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

Diese Option gilt nur für modernes Bootstrapping.

Um vertrauenswürdige Konten zu einem vorhandenen Bootstrap-Stack hinzuzufügen, müssen Sie alle Konten angeben, denen Sie vertrauen möchten, einschließlich der Konten, die Sie möglicherweise zuvor angegeben haben. Wenn Sie nur neue Konten angeben, denen Sie vertrauen können, werden die zuvor vertrauenswürdigen Konten entfernt.

Im Folgenden finden Sie ein Beispiel, bei dem zwei Konten als vertrauenswürdig eingestuft werden:

$ cdk bootstrap aws://123456789012/us-west-2 --trust 234567890123 --trust 987654321098 --cloudformation-execution-policies arn:aws:iam::aws:policy/AdministratorAccess ⏳ Bootstrapping environment aws://123456789012/us-west-2... Trusted accounts for deployment: 234567890123, 987654321098 Trusted accounts for lookup: (none) Execution policies: arn:aws:iam::aws:policy/AdministratorAccess CDKToolkit: creating CloudFormation changeset... ✅ Environment aws://123456789012/us-west-2 bootstrapped.
Wichtig

Die moderne Bootstrap-Vorlage gewährt praktisch jedem AWS Konto in der Liste die --cloudformation-execution-policies damit verbundenen Berechtigungen. --trust Standardmäßig werden dadurch die Lese- und Schreibberechtigungen für alle Ressourcen im Bootstrap-Konto erweitert. Stellen Sie sicher, dass Sie den Bootstrapping-Stack mit Richtlinien und vertrauenswürdigen Konten konfigurieren, mit denen Sie vertraut sind.

Standardwert: []

--trust-for-lookup ARRAY

Dem sollte vertraut werden AWS-Konto IDs, wenn es darum geht, Werte in dieser Umgebung nachzuschlagen.

Verwenden Sie diese Option, um Konten die Erlaubnis zu erteilen, Stacks zu synthetisieren, die in der Umgebung bereitgestellt werden, ohne ihnen tatsächlich die Erlaubnis zu geben, diese Stacks direkt bereitzustellen.

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

Diese Option gilt nur für modernes Bootstrapping.

Standardwert: []

Beispiele

Bootstrap für die im AWS Produktprofil angegebene Umgebung

$ cdk bootstrap --profile prod

Stellen Sie den Bootstrap-Stack in den Umgebungen foo und bar bereit

$ cdk bootstrap --app='node bin/main.js' foo bar

Exportieren Sie die Bootstrap-Vorlage, um sie anzupassen

Wenn Sie spezielle Anforderungen haben, die von der Bootstrap-Vorlage nicht erfüllt werden, können Sie sie an Ihre Bedürfnisse anpassen.

Sie können die Bootstrap-Vorlage exportieren, ändern und mithilfe dieser Methode bereitstellen. AWS CloudFormation Im Folgenden finden Sie ein Beispiel für den Export der vorhandenen Vorlage:

$ cdk bootstrap --show-template > bootstrap-template.yaml

Sie können die auch anweisen, eine benutzerdefinierte Vorlage CDK CLI zu verwenden. Im Folgenden wird ein Beispiel gezeigt:

$ cdk bootstrap --template my-bootstrap-template.yaml

Bootstrap mit einer Berechtigungsgrenze. Entfernen Sie dann diese Berechtigungsgrenze

Um mit einer benutzerdefinierten Berechtigungsgrenze zu booten, führen wir Folgendes aus:

$ cdk bootstrap --custom-permissions-boundary my-permissions-boundary

Um die Berechtigungsgrenze zu entfernen, führen wir Folgendes aus:

$ cdk bootstrap --no-previous-parameters

Verwenden Sie einen Qualifier, um Ressourcen zu unterscheiden, die für eine Entwicklungsumgebung erstellt wurden

$ cdk bootstrap --qualifier dev2024