View a markdown version of this page

cdk orphan - AWS Cloud Development Kit (AWS CDK) v2
UsageArgumenteOptionenBeispiele

Dies ist der AWS CDK v2-Entwicklerhandbuch. Das ältere CDK v1 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 orphan

Wichtig

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

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

Trennen Sie eine oder mehrere Ressourcen sicher von einem AWS CloudFormation Stapel, ohne sie zu löschen. Dies ist nützlich, wenn Sie eine Ressource ohne Ausfallzeiten oder Datenverlust von einem Konstrukttyp zu einem anderen migrieren müssen (z. B. eine DynamoDB Table zuTableV2).

Wenn Sie einen Konstrukttyp in Ihrem CDK-Code ändern, CloudFormation interpretiert dies als Ressourcenersatz, wodurch die vorhandene Ressource gelöscht und eine neue erstellt wird. Bei zustandsbehafteten Ressourcen wie Datenbanken und Speicher führt dies zu Datenverlust. Der cdk orphan Befehl löst dieses Problem, indem er zuerst die Ressource vom Stapel trennt, sodass Sie sie mit dem neuen Konstrukttyp erneut importieren können. cdk import

Mit cdk orphan haben Sie folgende Möglichkeiten:

  • Trennen Sie statusbehaftete Ressourcen von einem Stapel, bevor Sie ihren Konstrukttyp ändern.

  • Migrieren Sie ohne Datenverlust zwischen Konstruktversionen (z. B. DynamoDB Table zuTableV2).

  • Ändern Sie den CloudFormation Ressourcentyp, der ein Konstrukt unterstützt, ohne die physische Ressource zu ersetzen.

Der Orphan-Befehl führt drei CloudFormation Bereitstellungen durch:

  1. Verweise auflösen: Löst ressourcenübergreifende Verweise (Ref,Fn::GetAtt,Fn::Sub) auf die verwaisten Ressourcen auf, sodass andere Ressourcen im Stapel, die von ihnen abhängen, weiterhin funktionieren, nachdem die verwaisten Ressourcen entfernt wurden.

  2. Entkoppeln: Ersetzt alle ressourcenübergreifenden Verweise durch ihre aufgelösten Literalwerte, setzt Einträge auf und entfernt DependsOn EinträgeRetain, DeletionPolicy um die Ressourcen vom Rest des Stacks zu isolieren.

  3. Entfernen: Entfernt die Ressourcen aus der Vorlage. CloudFormation Die physischen Ressourcen sind weiterhin in Ihrem AWS Konto vorhanden.

Aktualisieren Sie nach dem Verwaisten Ihren CDK-Code so, dass er den neuen Konstrukttyp verwendet, und verwenden Sie cdk import, um die Ressource wieder zu verwalten.

Um eine Ressource zu verwaist und sie unter einem neuen Konstrukttyp erneut zu importieren

  1. Stellen Sie Ihren Stack bereit und überprüfen Sie, ob die Ressource vorhanden ist.

  2. Führen Sie es cdk orphan mit dem Konstruktpfad der Ressource aus:

    $ cdk orphan MyStack/MyTable --unstable=orphan

  3. Der Befehl gibt eine Ressourcenzuordnung aus. Speichern Sie dies für den Importschritt.

  4. Aktualisieren Sie Ihren CDK-Code, sodass er den neuen Konstrukttyp verwendet (z. B. ändern Table zuTableV2).

  5. Führen Sie das cdk import Programm mit der Ressourcenzuordnung aus der verwaisten Ausgabe aus:

    $ cdk import MyStack --resource-mapping-inline '{"MyTable":{"TableName":"my-table"}}'

  6. Nach Abschluss des Imports werden Abweichungen cdk import erkannt und Sie werden zur Bereitstellung aufgefordert. Akzeptieren Sie die Aufforderung, den Stapel abzugleichen.

Diese Funktion hat derzeit folgende Einschränkungen:

  • Alle Konstruktpfade müssen auf denselben Stapel verweisen. Das Verwaisten von Ressourcen über mehrere Stapel in einem einzigen Befehl wird nicht unterstützt.

  • Platzhaltermuster werden nicht unterstützt. Pfade werden als exakte Präfixe abgeglichen.

  • Für diesen Befehl ist Version 32 der Bootstrap-Vorlage erforderlich, die die erforderlichen IAM-Berechtigungen für die Bereitstellungsrolle enthält.

Usage

$ cdk orphan <PATHS> <options>

Argumente

PFADE

Ein oder mehrere Konstruktpfade zu Orphan im FormatStackName/ConstructPath. Beispiel, MyStack/MyTable. In einem einzigen Befehl können mehrere Pfade angegeben werden, um mehrere Ressourcen zu verwaisten Ressourcen.

Alle Pfade müssen auf denselben Stack verweisen.

Typ: Zeichenfolge

Erforderlich: Ja

Optionen

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

--help, -h <BOOLEAN>

Zeigt Befehlsreferenzinformationen für den cdk orphan Befehl an.

Beispiele

Eine einzelne Ressource verwaisten

$ cdk orphan MyStack/MyTable --unstable=orphan

Mehrere Ressourcen verwaisten

$ cdk orphan MyStack/MyTable MyStack/MyBucket --unstable=orphan

Bestätigungsaufforderung überspringen

$ cdk orphan MyStack/MyTable --unstable=orphan --yes