cdk refactor - AWS Cloud Development Kit (AWS CDK) v2
VerwendungArgumenteOptionen

Dies ist der AWS CDK v2-Entwicklerhandbuch. Das ältere CDK v1 wurde am 1. Juni 2022 gewartet 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 refactor

Wichtig

Der cdk refactor Befehl befindet sich in der Vorschauversion und kann sich ändern.

Sie müssen die --unstable=refactor Option angeben, wenn Sie diesen Befehl verwenden.

Schonen Sie bereitgestellte Ressourcen, wenn Sie Code in Ihrer AWS Cloud Development Kit (AWS CDK) -Anwendung umgestalten.

Wenn Sie Konstrukte umbenennen oder sie in Ihrem CDK-Code stapelweise verschieben, werden diese normalerweise als neue Ressourcen behandelt CloudFormation , was zu Ersetzungen führt, die zu Betriebsunterbrechungen oder Datenverlust führen können. Der cdk refactor Befehl erkennt diese Änderungen auf intelligente Weise und arbeitet mit der Refactoring-API zusammen, um Ihre Ressourcen zu CloudFormation schonen und gleichzeitig ihre logische Struktur zu aktualisieren. IDs

Mit cdk refactor haben Sie folgende Möglichkeiten:

  • Benennen Sie Konstrukte für eine bessere Übersichtlichkeit in Ihrer Codebasis um, ohne dass Ressourcen ersetzt werden.

  • Verschieben Sie Ressourcen zwischen Stapeln, um die Organisation zu verbessern und Aufgaben besser voneinander zu trennen.

  • Reorganisieren Sie Ihre Konstrukthierarchie (z. B. die Gruppierung von AWS-Ressourcen unter einem neuen L3-Konstrukt) und behalten Sie dabei die zugrunde liegenden Cloud-Ressourcen bei.

  • Führen Sie ein sicheres Upgrade durch oder wechseln Sie zwischen Konstruktbibliotheken, einschließlich Abhängigkeiten von Drittanbietern, ohne dass bei einem logischen IDs Wechsel zwischen Versionen Ressourcen ersetzt werden.

Dieser Befehl analysiert Ihre Änderungen, zeigt Ihnen eine Liste von Ressourcen an, deren Speicherort (Stapel und logische ID) geändert wird, und übernimmt den komplexen Prozess der Aktualisierung von CloudFormation Ressourcen unter Beibehaltung ihrer Identität und ihres Status.

Wenn der Befehl ausgeführt wird, berechnet er automatisch Zuordnungen, indem er Ihren aktuellen Code mit dem bereitgestellten Status vergleicht. Es überprüft, ob Ihre CDK-Anwendung genau den gleichen Satz von Ressourcen wie der bereitgestellte Status enthält und sich nur in ihren Positionen im Konstruktbaum unterscheidet. Wenn der Befehl feststellt, dass Ressourcen hinzugefügt, gelöscht oder geändert wurden, wird der Refactoring-Vorgang mit einer Fehlermeldung abgelehnt.

Nach der Zuordnungsberechnung zeigt Ihnen der Befehl die vorgeschlagenen Änderungen an und wendet nach Bestätigung durch den Benutzer das Refactoring an. Wenn Mehrdeutigkeit festgestellt wird (wobei mehrere gültige Zuordnungen möglich sind), können Sie eine Override-Datei mit expliziten Zuordnungen bereitstellen, um diese Fälle zu lösen.

Eine Einführung finden Sie unter Beibehaltung der bereitgestellten Ressourcen beim Refactoring von CDK-Code.

Verwendung

$ cdk refactor <arguments> <options>

Argumente

CDK-Stack-ID

Die Konstrukt-ID des CDK-Stacks von Ihrer App zum Refactor.

Sie können mehrere Stapel angeben IDs , um den Refactoring-Vorgang auf diese Stacks zu konzentrieren. Wenn Ressourcen zwischen Stacks verschoben werden und einer dieser Stapel nicht explizit enthalten ist, bezieht der Refactor-Befehl den zusätzlichen Stapel automatisch in den Vorgang mit ein.

Wenn Sie keinen Stack angeben IDs, werden alle Stapel in der App für das Refactoring berücksichtigt.

Typ: Zeichenfolge

Required: No

Optionen

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

--dry-run

Drucken Sie das Mapping auf der Konsole aus, ohne es anzuwenden.

Diese Option ist nützlich, um Ihre Änderungen vor dem eigentlichen Refactoring zu überprüfen, insbesondere bei der Arbeit mit komplexen Anwendungen. Sie zeigt Ihnen genau, welche Änderungen vorgenommen werden würden, ohne dass Ressourcen geändert würden.

--force

Fahren Sie mit dem Refactoring fort, ohne den Benutzer zur Bestätigung aufzufordern.

Dies ist in interaktiven Umgebungen nützlich, wenn Sie sich der Änderungen sicher sind. In nicht interaktiven Umgebungen wie CI/CD Pipelines fährt die CDK-CLI automatisch ohne Aufforderung fort, sodass diese Option nicht erforderlich ist.

--help, -h <BOOLEAN>

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

--override-file <FILE>

Stellen Sie Overrides bereit, wenn die CDK-CLI keine Refactoring-Auflösung für Ressourcen ermitteln kann. Diese Datei enthält Ressourcenzuordnungen im JSON-Format. Im Folgenden wird ein Beispiel gezeigt:

{
    "environments": [
        {
            "account": "123456789012",
            "region": "us-east-2",
            "resources": {
                "StackA.OldName": "StackB.NewName",
                "StackC.Foo": "StackC.Bar"
            }
        }
    ]
}
--revert <FILE>

Macht einen früheren Refactor rückgängig. Sie müssen eine Override-Datei mit Ressourcenzuordnungen bereitstellen.

Dadurch wird ein früherer Refactoring-Vorgang nicht vollständig rückgängig gemacht. Um einen Refactor vollständig rückgängig zu machen, müssen Sie Ihre App auf einen früheren Status zurücksetzen und den Refactoring-Prozess erneut ausführen.