cdk watch - AWS Cloud Development Kit (AWS CDK) v2
VerwendungArgumenteOptionenBeispiele

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 watch

Überwachen Sie ein lokales AWS CDK Projekt kontinuierlich auf Änderungen bei der Durchführung von Implementierungen und Hotswaps.

Dieser Befehl ähnelt dem Befehl, mit dem Unterschiedcdk deploy, dass er kontinuierliche Bereitstellungen und Hotswaps mit einem einzigen Befehl ausführen kann.

Dieser Befehl ist eine Abkürzung für. cdk deploy --watch

Um eine cdk watch Sitzung zu beenden, unterbrechen Sie den Vorgang, indem Sie aufCtrl+C.

Welche Dateien beobachtet werden, hängt von der "watch" Einstellung in Ihrer cdk.json Datei ab. Es hat zwei Unterschlüssel, "include" und"exclude", das akzeptiert eine einzelne Zeichenfolge oder ein Array von Zeichenketten. Jeder Eintrag wird als Pfad relativ zum Speicherort der cdk.json Datei interpretiert. Beides * und ** werden akzeptiert.

Wenn Sie mit dem cdk init Befehl ein Projekt erstellen, ist das folgende Standardverhalten cdk watch in der cdk.json Datei Ihres Projekts konfiguriert:

  • "include"ist auf gesetzt"**/*", was alle Dateien und Verzeichnisse im Stammverzeichnis des Projekts einschließt.

  • "exclude"ist optional, mit Ausnahme von Dateien und Ordnern, die bereits standardmäßig ignoriert wurden. Dies besteht aus Dateien und Verzeichnissen, die mit., dem CDK Ausgabeverzeichnis und dem node_modules Verzeichnis beginnen.

Die zu konfigurierende Mindesteinstellung watch ist"watch": {}.

Wenn für Ihren CDK Code oder Ihren Anwendungscode vor der Bereitstellung ein Build-Schritt erforderlich ist, cdk watch funktioniert es mit dem "build" Schlüssel in der cdk.json Datei.

Anmerkung

Dieser Befehl gilt als experimentell und könnte in future grundlegende Änderungen haben.

Die gleichen Einschränkungen von cdk deploy --hotswap gelten fürcdk watch. Weitere Informationen finden Sie unter cdk deploy --hotswap.

Verwendung

$ cdk watch <arguments> <options>

Argumente

CDKStapel-ID

Die Konstrukt-ID des CDK Stacks aus Ihrer App, den Sie sich ansehen möchten.

Typ: Zeichenfolge

Required: No

Optionen

Für eine Liste globaler Optionen, die mit allen funktionieren CDK CLI Befehle finden Sie unterGlobale Optionen.

--build-exclude, -E ARRAY

Das Asset mit der angegebenen ID darf nicht neu erstellt werden.

Diese Option kann in einem einzigen Befehl mehrfach angegeben werden.

Standardwert: []

--change-set-name STRING

Der Name des zu erstellenden CloudFormation Änderungssatzes.

--concurrency NUMBER

Stellen Sie mehrere Stacks parallel bereit und tauschen Sie sie per Hotswap aus, wobei die Abhängigkeiten zwischen den Stacks berücksichtigt werden. Verwenden Sie diese Option, um Bereitstellungen zu beschleunigen. Sie müssen immer noch andere CloudFormation AWS-Konto Ratenbegrenzungen berücksichtigen.

Geben Sie eine Zahl ein, um die maximale Anzahl gleichzeitiger Bereitstellungen anzugeben (sofern die Abhängigkeit dies zulässt).

Standardwert: 1

--exclusively, -e BOOLEAN

Stellen Sie nur angeforderte Stacks bereit und schließen Sie keine Abhängigkeiten ein.

--force, -f BOOLEAN

Stellen Sie immer Stacks bereit, auch wenn die Vorlagen identisch sind.

Standardwert: false

--help, -h BOOLEAN

Zeigt Befehlsreferenzinformationen für den cdk watch Befehl an.

--hotswap BOOLEAN

cdk watchVerwendet standardmäßig Hotswap-Bereitstellungen, wenn möglich, um Ihre Ressourcen zu aktualisieren. Das CDK CLI versucht, eine Hotswap-Bereitstellung durchzuführen, und greift nicht auf eine vollständige CloudFormation Bereitstellung zurück, falls dies nicht erfolgreich ist. Alle erkannten Änderungen, die nicht über einen Hotswap aktualisiert werden können, werden ignoriert.

Standardwert: true

--hotswap-fallback BOOLEAN

cdk watchVersucht standardmäßig, Hotswap-Bereitstellungen durchzuführen, und ignoriert Änderungen, die Bereitstellungen erfordern. CloudFormation Stellen Sie sicher--hotswap-fallback, dass Sie auf eine vollständige Bereitstellung zurückgreifen und eine vollständige CloudFormation Bereitstellung durchführen können, falls die Hotswap-Bereitstellung nicht erfolgreich ist.

--logs BOOLEAN

cdk watchÜberwacht standardmäßig alle CloudWatch Protokollgruppen in Ihrer Anwendung und streamt die Protokollereignisse lokal an. stdout

Standardwert: true

--progress STRING

Konfigurieren Sie, wie CDK CLI zeigt den Fortschritt der Bereitstellung an.

  • bar— Zeigt Ereignisse bei der Stack-Bereitstellung als Fortschrittsbalken an, zusammen mit den Ereignissen für die Ressource, die gerade bereitgestellt wird.

  • events— Stellen Sie einen vollständigen Verlauf bereit, einschließlich aller CloudFormation Ereignisse.

Sie können diese Option auch in der cdk.json Projektdatei oder ~/.cdk.json auf Ihrem lokalen Entwicklungscomputer konfigurieren:

{
   "progress": "events"
}

Zulässige Werte: bar, events

Standardwert: bar

--rollback BOOLEAN

Wenn während der Bereitstellung eine Ressource nicht erstellt oder aktualisiert werden kann, wird die Bereitstellung auf den letzten stabilen Status vor dem CDK CLI kehrt zurück. Alle bis zu diesem Zeitpunkt vorgenommenen Änderungen werden rückgängig gemacht. Ressourcen, die erstellt wurden, werden gelöscht und vorgenommene Aktualisierungen werden rückgängig gemacht.

Verwenden Sie --no-rollback oder-R, um dieses Verhalten zu deaktivieren. Wenn eine Ressource nicht erstellt oder aktualisiert werden kann, CDK CLI behält die bis zu diesem Zeitpunkt vorgenommenen Änderungen bei und kehrt zurück. Dies kann in Entwicklungsumgebungen hilfreich sein, in denen Sie schnell iterieren.

Anmerkung

Wann werden Bereitstellungenfalse, die zu einem Austausch von Ressourcen führen, immer fehlschlagen. Sie können diesen Wert nur für Bereitstellungen verwenden, die neue Ressourcen aktualisieren oder erstellen.

Standardwert: true

--toolkit-stack-name STRING

Der Name des vorhandenen CDK Toolkit-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.

Der CDK CLI verwendet diesen Wert, um Ihre Bootstrap-Stack-Version zu überprüfen.

Beispiele

Überwachen Sie einen CDK Stack mit logischer ID DevelopmentStack auf Änderungen

$ cdk watch DevelopmentStack
Detected change to 'lambda-code/index.js' (type: change). Triggering 'cdk deploy'
DevelopmentStack: deploying...

 ✅  DevelopmentStack

Konfigurieren Sie in einer cdk.json-Datei, welche Elemente ein- und ausgeschlossen werden sollen, damit sie nicht auf Änderungen überprüft werden

{
   "app": "mvn -e -q compile exec:java",
   "watch": {
    "include": "src/main/**",
    "exclude": "target/*"
   }
}

Erstellen Sie ein Projekt mit CDK Java vor der Bereitstellung, indem Sie die Datei cdk.json konfigurieren

{
  "app": "mvn -e -q exec:java",
  "build": "mvn package",
  "watch": {
    "include": "src/main/**",
    "exclude": "target/*"
  }
}