Dies ist das AWS CDK v2 Developer Guide. Für das ältere CDK v1 wurde am 1. Juni 2022 die Wartung abgeschlossen und der Support endete am 1. Juni 2023.
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 benannten CDKToolkit CDK-Bootstrap-Stack in der Umgebung bereitstellen. AWS
Der Bootstrap-Stack ist ein CloudFormation Stack, der einen Amazon S3-Bucket und ein Amazon ECR-Repository in der Umgebung bereitstellt. AWS Die AWS CDK-CLI verwendet diese Ressourcen, um synthetisierte Vorlagen und zugehörige Ressourcen während der Bereitstellung zu speichern.
Usage
$ 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-1Dieses Argument kann mehrfach in einem einzigen Befehl angegeben werden, um den Bootstrap-Stack in mehreren Umgebungen bereitzustellen.
Standardmäßig bootet die CDK-CLI alle Umgebungen, auf die in der CDK-App verwiesen wird, oder bestimmt eine Umgebung aus Standardquellen. Dies kann eine mit der
--profileOption angegebene Umgebung aus Umgebungsvariablen oder AWS Standard-CLI-Quellen sein.
Optionen
Eine Liste der globalen Optionen, die mit allen CDK-CLI-Befehlen funktionieren, finden Sie unter Globale Optionen.
-
--bootstrap-bucket-name, --toolkit-bucket-name, -b <STRING> -
Der Name des Amazon S3-Buckets, der von der CDK-CLI verwendet wird. Dieser Bucket wird erstellt und darf derzeit nicht existieren.
Geben Sie diese Option an, um den Standardnamen des Amazon S3-Buckets zu überschreiben.
Wenn Sie diese Option verwenden, müssen Sie möglicherweise die Synthese anpassen. Weitere Informationen finden Sie unter Anpassen der CDK-Stack-Synthese.
Standardwert: Undefiniert
-
--bootstrap-customer-key <BOOLEAN> -
Erstellen Sie einen Customer Master Key (CMK) für den Bootstrap-Bucket (Ihnen fallen Gebühren an, aber Sie können die Berechtigungen anpassen, nur modernes Bootstrapping).
Diese Option ist nicht kompatibel mit.
--bootstrap-kms-key-idStandardwert: Undefiniert
-
--bootstrap-kms-key-id <STRING> -
Die AWS KMS-Hauptschlüssel-ID, die für die
SSE-KMSVerschlüsselung verwendet werden soll.Geben Sie diese Option an, um den AWS Standard-KMS-Schlüssel zu überschreiben, der zum Verschlüsseln des Amazon S3-Buckets verwendet wird.
Diese Option ist nicht kompatibel mit
--bootstrap-customer-key.Standardwert: Undefiniert
-
--express <BOOLEAN> -
Bootstrap im CloudFormation Expressmodus. Der Expressmodus ermöglicht schnellere Bereitstellungen, CloudFormation indem Stack-Operationen als abgeschlossen gemeldet werden, sobald die CloudFormation Ressourcenkonfiguration angewendet wird. Meldet jedoch Erfolge CloudFormation , ohne darauf zu warten, dass sich die Ressourcen stabilisieren. Außerdem führt der Expressmodus kein automatisches Rollback durch, sodass Stapel in einem fehlerhaften Zustand zurückbleiben, wenn etwas schief geht.
Weitere Informationen finden Sie im AWS CloudFormation Benutzerhandbuch unter Expressmodus.
Standardwert:
false
-
--cloudformation-execution-policies <ARRAY> -
Die ARNs der verwalteten IAM-Richtlinien, die der Bereitstellungsrolle zugeordnet werden sollten, die sie AWS CloudFormation bei der Bereitstellung Ihrer Stacks übernommen haben.
Standardmäßig werden Stacks mithilfe der Richtlinie mit vollen Administratorberechtigungen bereitgestellt.
AdministratorAccessSie können diese Option mehrmals in einem einzigen Befehl angeben. Sie können auch mehrere ARNs als einzelne Zeichenfolge angeben, wobei die einzelnen ARNs durch Kommas getrennt sind. 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 Bootstrapping-Umgebung durchführen, ausreichend sind.
Diese Option gilt nur für modernes Bootstrapping.
Wichtig
Die moderne Bootstrap-Vorlage gewährt effektiv jedem AWS Konto in der Liste die
--cloudformation-execution-policiesin der Liste enthaltenen Berechtigungen.--trustStandardmäßig erweitert dies die Lese- und Schreibberechtigungen für alle Ressourcen im Bootstrapping-Konto. 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 eine Berechtigungsgrenze, die vom AWS CDK bereitgestellt wird.
Diese Option ist nicht kompatibel mit
--custom-permissions-boundary.Die vom CDK bereitgestellte 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 existiert. Es geht darum, Abweichungen zu vermeiden. Höchstwahrscheinlich wird eine Berechtigungsgrenze beibehalten und es gibt spezielle Konventionen, einschließlich der Benennung.
Weitere Informationen zur Konfiguration von Berechtigungen, einschließlich der Verwendung von Berechtigungsgrenzen, 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> -
Immer Bootstrap, 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 frühere Werte für vorhandene Parameter.
Sobald eine Bootstrap-Vorlage mit einer Reihe von Parametern bereitgestellt wurde, müssen Sie diese Option auf einstellen,
falseum alle Parameter bei zukünftigen Bereitstellungen zu ändern. In diesemfalseFall müssen Sie alle zuvor angegebenen Parameter erneut angeben.Standardwert:
true
-
--public-access-block-configuration <BOOLEAN> -
Blockieren Sie die Konfiguration für den öffentlichen Zugriff auf den Amazon S3-Bucket, der von der CDK-CLI erstellt und verwendet wird.
Standardwert:
true
-
--qualifier <STRING> -
Nine-digit Zeichenkettenwert, der für jeden Bootstrap-Stack eindeutig ist. Dieser Wert wird zur physischen ID der Ressourcen im Bootstrap-Stack hinzugefügt.
Durch die Angabe eines Qualifizierers vermeiden Sie Konflikte zwischen 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 Anpassen der CDK-Stack-Synthese.
Standardwert:
hnb659fds. Dieser Wert hat keine Bedeutung.
-
--show-template <BOOLEAN> -
Anstatt Bootstrapping durchzuführen, drucken Sie die aktuelle Bootstrap-Vorlage in die Standardausgabe ().
stdoutAnschließ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 von
KEY=VALUE.Standardwert:
[]
-
--template <STRING> -
Verwenden Sie die Vorlage aus der angegebenen Datei anstelle der integrierten.
-
--termination-protection <BOOLEAN> -
Schalten Sie den AWS CloudFormation Kündigungsschutz auf dem Bootstrap-Stack ein.
Wann ist
trueder Kündigungsschutz aktiviert. Dadurch wird verhindert, dass der Bootstrap-Stack versehentlich gelöscht wird.Weitere Informationen zum Kündigungsschutz finden Sie unter Schützen eines Stacks vor dem Löschen im AWS CloudFormation Benutzerhandbuch.
Standardwert: Undefiniert
-
--toolkit-stack-name <STRING> -
Der Name des Bootstrap-Stacks, der erstellt werden soll.
cdk bootstrapStellt standardmäßig einen Stack bereit, derCDKToolkitin der angegebenen AWS Umgebung benannt ist. Verwenden Sie diese Option, um einen anderen Namen für Ihren Bootstrap-Stack anzugeben.Die CDK-CLI verwendet diesen Wert, um Ihre Bootstrap-Stack-Version zu überprüfen.
Standardwert:
CDKToolkitErforderlich: Ja
-
--trust <ARRAY> -
Die AWS Konto-IDs, denen vertraut werden sollte, um Bereitstellungen in dieser Umgebung durchzuführen.
Dem Konto, das das Bootstrapping durchführt, wird immer vertraut.
Für diese Option müssen Sie auch Folgendes angeben.
--cloudformation-execution-policiesSie können diese Option mehrmals in einem einzigen Befehl angeben.
Diese Option gilt nur für modernes Bootstrapping.
Um einem vorhandenen Bootstrap-Stack vertrauenswürdige Konten hinzuzufügen, müssen Sie alle Konten angeben, denen Sie vertrauen sollen, 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 effektiv jedem AWS Konto in der Liste
--cloudformation-execution-policiesdie in der--trustListe enthaltenen Berechtigungen. Standardmäßig erweitert dies die Lese- und Schreibberechtigungen für alle Ressourcen im Bootstrapping-Konto. 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> -
Die AWS Konto-IDs, denen vertraut werden sollte, um Werte in dieser Umgebung abzurufen.
Verwenden Sie diese Option, um Konten die Erlaubnis zu geben, 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 mehrmals in einem einzigen Befehl angeben.
Diese Option gilt nur für modernes Bootstrapping.
Standardwert:
[]
Beispiele
Bootstrappen Sie das AWS Die im 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 bestimmte 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 mit AWS CloudFormation ihr bereitstellen. Das Folgende ist ein Beispiel für den Export der vorhandenen Vorlage:
$ cdk bootstrap --show-template > bootstrap-template.yaml
Sie können die CDK-CLI auch anweisen, eine benutzerdefinierte Vorlage 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 Qualifizierer, um Ressourcen zu unterscheiden, die für eine Entwicklungsumgebung erstellt wurden
$ cdk bootstrap --qualifier dev2024