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.
AWS CDKCLIBefehlsreferenz
Dieser Abschnitt enthält Befehlsreferenzinformationen für die AWS Cloud Development Kit (AWS CDK) Befehlszeilenschnittstelle ()CLI. Das CDK CLI wird auch als CDK-Toolkit bezeichnet.
Verwendung
$
cdk
<command>
<arguments>
<options>
Befehle
acknowledge, ack
-
Bestätigen Sie einen Hinweis anhand der Problemnummer und verhindern Sie, dass er erneut angezeigt wird.
bootstrap
-
Bereiten Sie eine AWS Umgebung für CDK-Bereitstellungen vor, indem Sie den CDK-Bootstrap-Stack (genannt
CDKToolkit
) in der Umgebung bereitstellen. AWS context
-
Verwalten Sie zwischengespeicherte Kontextwerte für Ihre CDK-Anwendung.
deploy
-
Stellen Sie einen oder mehrere CDK-Stacks in Ihrer Umgebung bereit. AWS
destroy
-
Löschen Sie einen oder mehrere CDK-Stacks aus Ihrer Umgebung. AWS
diff
-
Führen Sie einen Vergleich durch, um die Infrastrukturänderungen zwischen den CDK-Stacks zu sehen.
docs, doc
-
Öffnen Sie die CDK-Dokumentation in Ihrem Browser.
doctor
-
Sehen Sie sich nützliche Informationen über Ihr lokales CDK-Projekt und Ihre Entwicklungsumgebung an und zeigen Sie sie an.
import
-
Verwenden Sie AWS CloudFormation Ressourcenimporte, um vorhandene AWS Ressourcen in einen CDK-Stack zu importieren.
init
-
Erstellen Sie ein neues CDK-Projekt aus einer Vorlage.
list, ls
-
Listet alle CDK-Stacks und ihre Abhängigkeiten von einer CDK-App auf.
metadata
-
Zeigt Metadaten an, die einem CDK-Stack zugeordnet sind.
migrate
-
Migrieren Sie AWS Ressourcen, AWS CloudFormation Stacks und AWS CloudFormation Vorlagen in ein neues CDK-Projekt.
notices
-
Zeigen Sie Hinweise für Ihre CDK-Anwendung an.
synthesize, synth
-
Synthetisieren Sie eine CDK-App, um eine Cloud-Assembly zu erstellen, einschließlich einer AWS CloudFormation Vorlage für jeden Stapel.
watch
-
Beobachten Sie ein lokales CDK-Projekt kontinuierlich auf Änderungen bei der Durchführung von Implementierungen und Hotswaps.
Globale Optionen
Die folgenden Optionen sind mit allen CLI CDK-Befehlen kompatibel.
--app, -a
STRING
-
Geben Sie den Befehl zum Ausführen Ihres App- oder Cloud-Assembly-Verzeichnisses an.
Erforderlich: Ja
--asset-metadata
BOOLEAN
-
Fügen Sie
aws:asset:*
AWS CloudFormation Metadaten für Ressourcen hinzu, die Ressourcen verwenden.Required: No
Standardwert:
true
--build
STRING
-
Befehl zum Ausführen eines Pre-Synthese-Builds.
Required: No
--ca-bundle-path
STRING
-
Pfad zu einem CA-Zertifikat, das bei der Validierung von HTTPS-Anfragen verwendet werden soll.
Wenn diese Option nicht angegeben ist, liest das CDK CLI aus der
AWS_CA_BUNDLE
Umgebungsvariablen.Erforderlich: Ja
--ci
BOOLEAN
-
Geben Sie an, dass CLI CDK-Befehle in einer CI-Umgebung (Continuous Integration) ausgeführt werden.
Diese Option ändert das Verhalten des CDK, CLI um es besser an automatisierte Abläufe anzupassen, die für CI-Pipelines typisch sind.
Wenn Sie diese Option angeben, werden Protokolle an statt an
stdout
gesendet.stderr
Required: No
Standardwert:
false
--context, -c
ARRAY
-
Fügen Sie kontextbezogene Zeichenkettenparameter als Schlüssel-Wert-Paare hinzu.
--debug
BOOLEAN
-
Aktivieren Sie detaillierte Debugging-Informationen. Diese Option erzeugt eine ausführliche Ausgabe, die viel mehr Details darüber enthält, was das CDK hinter den Kulissen CLI tut.
Required: No
Standardwert:
false
--ec2creds, -i
BOOLEAN
-
Zwingen Sie das CDKCLI, zu versuchen, Amazon EC2 EC2-Instance-Anmeldeinformationen abzurufen.
Standardmäßig CLI errät das CDK den Amazon EC2 EC2-Instance-Status.
Required: No
Standardwert:
false
--help, -h
BOOLEAN
-
Zeigt Befehlsreferenzinformationen für das CDK an. CLI
Required: No
Standardwert:
false
--ignore-errors
BOOLEAN
-
Ignorieren Sie Synthesefehler, da diese wahrscheinlich zu einer ungültigen Ausgabe führen.
Required: No
Standardwert:
false
--json, -j
BOOLEAN
-
Verwenden Sie JSON anstelle von YAML für AWS CloudFormation Vorlagen, die in der Standardausgabe (
stdout
) gedruckt werden.Required: No
Standardwert:
false
--lookups
BOOLEAN
-
Führen Sie Kontext-Lookups durch.
Die Synthese schlägt fehl, wenn dieser Wert gleich ist
false
und Kontext-Lookups durchgeführt werden müssen.Required: No
Standardwert:
true
--no-color
BOOLEAN
-
Entfernen Sie Farbe und anderes Design aus der Konsolenausgabe.
Required: No
Standardwert:
false
--notices
BOOLEAN
-
Zeigen Sie relevante Hinweise an.
Required: No
Standardwert:
false
--output, -o
STRING
-
Geben Sie das Verzeichnis an, in das die synthetisierte Cloud-Assembly ausgegeben werden soll.
Erforderlich: Ja
Standardwert:
cdk.out
--path-metadata
BOOLEAN
-
Fügen Sie
aws::cdk::path
AWS CloudFormation Metadaten für jede Ressource hinzu.Required: No
Standardwert:
true
--plugin, -p
ARRAY
-
Name oder Pfad eines node Pakets, das die CDK-Funktionen erweitert. Diese Option kann in einem einzigen Befehl mehrfach angegeben werden.
Sie können diese Option in der
cdk.json
Projektdatei oder~/.cdk.json
auf Ihrem lokalen Entwicklungscomputer konfigurieren:{ // ... "plugin": [ "module_1", "module_2" ], // ... }
Required: No
--profile
STRING
-
Geben Sie den Namen des AWS Profils an, das Ihre AWS Umgebungsinformationen enthält und mit dem CDK CLI verwendet werden soll.
Erforderlich: Ja
--proxy
STRING
-
Verwenden Sie den angegebenen Proxy.
Wenn diese Option nicht angegeben ist, liest CLI das CDK aus der
HTTPS_PROXY
Umgebungsvariablen.Erforderlich: Ja
Standardwert: Aus der
HTTPS_PROXY
Umgebungsvariablen lesen. --role-arn, -r
STRING
-
Der ARN der IAM-Rolle, den der CDK bei der Interaktion mit ihm CLI übernimmt. AWS CloudFormation
Required: No
--staging
BOOLEAN
-
Kopieren Sie die Assets in das Ausgabeverzeichnis.
Geben Sie
false
an, dass das Kopieren von Assets in das Ausgabeverzeichnis verhindert werden soll. Dadurch kann beim AWS SAM CLI lokalen Debuggen auf die ursprünglichen Quelldateien verwiesen werden.Required: No
Standardwert:
true
--strict
BOOLEAN
-
Konstruieren Sie keine Stapel, die Warnungen enthalten.
Required: No
Standardwert:
false
--trace
BOOLEAN
-
Druckt den Trace für Stack-Warnungen.
Required: No
Standardwert:
false
--verbose, -v
COUNT
-
Debug-Protokolle anzeigen. Sie können diese Option mehrfach angeben, um die Ausführlichkeit zu erhöhen.
Required: No
--version
BOOLEAN
-
Zeigt die CLI CDK-Versionsnummer an.
Required: No
Standardwert:
false
--version-reporting
BOOLEAN
-
Nehmen Sie die
AWS::CDK::Metadata
Ressource in synthetisierte Vorlagen AWS CloudFormation auf.Required: No
Standardwert:
true
Bereitstellung und Konfiguration von Optionen
Sie können Optionen über Befehlszeilenargumente übergeben. Für die meisten Optionen können Sie sie in einer cdk.json
Konfigurationsdatei konfigurieren. Wenn Sie mehrere Konfigurationsquellen verwenden, hat das CLI CDK die folgende Priorität:
-
Befehlszeilenwerte — Jede in der Befehlszeile angegebene Option überschreibt die in Dateien konfigurierten Optionen.
cdk.json
-
Projektkonfigurationsdatei — Die
cdk.json
Datei im Verzeichnis Ihres CDK-Projekts. -
Benutzerkonfigurationsdatei — Die
cdk.json
Datei, die sich~/.cdk.json
auf Ihrem lokalen Computer befindet.
Optionen an der Befehlszeile übergeben
Boolesche Werte übergeben
Für Optionen, die einen booleschen Wert akzeptieren, können Sie sie auf folgende Weise angeben:
-
Verwendung
true
undfalse
Werte — Geben Sie den booleschen Wert mit dem Befehl an. Im Folgenden wird ein Beispiel gezeigt:$
cdk deploy --watch=true
$
cdk deploy --watch=false
-
Geben Sie das Gegenstück zur Option an — Ändern Sie den Optionsnamen, indem Sie ihn hinzufügen
no
, um einenfalse
Wert anzugeben. Im Folgenden wird ein Beispiel gezeigt:$
cdk deploy --watch
$
cdk deploy --no-watch
-
Bei Optionen, die standardmäßig auf
true
oder gesetzt sindfalse
, müssen Sie die Option nicht angeben, es sei denn, Sie möchten die Standardeinstellung ändern.