cdk migrate - AWS Cloud Development Kit (AWS CDK) v2
VerwendungOptionenBeispiele

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 migrate

Migrieren Sie bereitgestellte AWS Ressourcen, AWS CloudFormation Stacks und CloudFormation Vorlagen in ein neues AWS CDK-Projekt.

Mit diesem Befehl wird eine neue CDK-App erstellt, die einen einzelnen Stack enthält, dem der von Ihnen angegebene Wert zugewiesen wird. --stack-name Sie können die Migrationsquelle mit --from-scan--from-stack, oder --from-path konfigurieren.

Weitere Informationen zur Verwendung cdk migrate finden Sie unter Migrieren vorhandener Ressourcen und AWS CloudFormation Vorlagen zum AWS CDK.

Anmerkung

Der cdk migrate Befehl ist experimentell und könnte in future grundlegende Änderungen haben.

Verwendung

$ cdk migrate <options>

Optionen

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

Erforderliche Optionen

--stack-name <STRING>

Der Name des AWS CloudFormation Stacks, der nach der Migration in der CDK-App erstellt wird.

Erforderlich: Ja

Bedingte Optionen

--from-path <PATH>

Der Pfad zur AWS CloudFormation Vorlage, die migriert werden soll. Geben Sie diese Option an, um eine lokale Vorlage anzugeben.

Erforderlich: Bedingt. Erforderlich, wenn von einer lokalen AWS CloudFormation Vorlage migriert wird.

--from-scan <STRING>

Wenn Sie bereitgestellte Ressourcen aus einer AWS Umgebung migrieren, verwenden Sie diese Option, um anzugeben, ob ein neuer Scan gestartet werden soll oder ob die AWS CDK-CLI den letzten erfolgreichen Scan verwenden soll.

Erforderlich: Bedingt. Erforderlich bei der Migration von bereitgestellten Ressourcen. AWS

Zulässige Werte:most-recent, new

--from-stack <BOOLEAN>

Stellen Sie diese Option bereit, um von einem bereitgestellten AWS CloudFormation Stack zu migrieren. Wird verwendet--stack-name, um den Namen des bereitgestellten AWS CloudFormation Stacks anzugeben.

Erforderlich: Bedingt. Erforderlich, wenn von einem bereitgestellten AWS CloudFormation Stack migriert wird.

Optionale Optionen

--account <STRING>

Das Konto, von dem die AWS CloudFormation Stack-Vorlage abgerufen werden soll.

Required: No

Standard: Die AWS CDK-CLI bezieht Kontoinformationen aus Standardquellen.

--compress <BOOLEAN>

Stellen Sie diese Option bereit, um das generierte CDK-Projekt in eine Datei zu komprimieren. ZIP

Required: No

--filter <ARRAY>

Wird verwendet, wenn bereitgestellte Ressourcen aus einem AWS Konto und AWS einer Region migriert werden. Diese Option gibt einen Filter an, mit dem bestimmt wird, welche bereitgestellten Ressourcen migriert werden sollen.

Diese Option akzeptiert ein Array von Schlüssel-Wert-Paaren, wobei key für den Filtertyp und value für den zu filternden Wert steht.

Die folgenden Schlüssel werden akzeptiert:

  • resource-identifier— Ein Bezeichner für die Ressource. Der Wert kann die logische oder physische ID der Ressource sein. Beispiel, resource-identifier="ClusterName".

  • resource-type-prefix— Das Präfix AWS CloudFormation für den Ressourcentyp. Geben Sie beispielsweise resource-type-prefix="AWS::DynamoDB::" an, dass alle Amazon DynamoDB-Ressourcen gefiltert werden sollen.

  • tag-key— Der Schlüssel eines Ressourcen-Tags. Beispiel, tag-key="myTagKey".

  • tag-value— Der Wert eines Ressourcen-Tags. Beispiel, tag-value="myTagValue".

Stellen Sie mehrere Schlüssel-Wert-Paare für die AND bedingte Logik bereit. Das folgende Beispiel filtert nach jeder DynamoDB-Ressource, die mit myTagKey dem Tag-Schlüssel gekennzeichnet ist:. --filter resource-type-prefix="AWS::DynamoDB::", tag-key="myTagKey"

Geben Sie die --filter Option für OR bedingte Logik mehrmals in einem einzigen Befehl an. Das folgende Beispiel filtert nach jeder Ressource, die eine DynamoDB-Ressource ist oder mit der myTagKey als Tag-Schlüssel gekennzeichnet ist:. --filter resource-type-prefix="AWS::DynamoDB::" --filter tag-key="myTagKey"

Required: No

--help, -h <BOOLEAN>

Zeigt Befehlsreferenzinformationen für den cdk migrate Befehl an.

--language <STRING>

Die Programmiersprache, die für das CDK-Projekt verwendet werden soll, das während der Migration erstellt wurde.

Required: No

Gültige Werte:typescript,python,, javacsharp,go.

Standardwert: typescript

--output-path <PATH>

Der Ausgabepfad für das migrierte CDK-Projekt.

Required: No

Standard: Standardmäßig verwendet die AWS CDK-CLI Ihr aktuelles Arbeitsverzeichnis.

--region <STRING>

Die AWS Region, aus der die AWS CloudFormation Stack-Vorlage abgerufen werden soll.

Required: No

Standard: Die AWS CDK-CLI bezieht AWS Regionsinformationen aus Standardquellen.

Beispiele

Einfaches Beispiel für die Migration von einem Stack CloudFormation

Migrieren Sie von einem bereitgestellten CloudFormation Stack in einer bestimmten AWS Umgebung mithilfe von--from-stack. Geben Sie --stack-name einen Namen für Ihren neuen CDK-Stack an. Im Folgenden finden Sie ein Beispiel für die Migration myCloudFormationStack zu einer neuen CDK-App, die Folgendes verwendet: TypeScript

$ cdk migrate --language typescript --from-stack --stack-name 'myCloudFormationStack'

Einfaches Beispiel für die Migration von einer lokalen Vorlage CloudFormation

Migrieren Sie von einer lokalen JSON- oder CloudFormation YAML-Vorlage mit. --from-path Geben Sie --stack-name an, ob Sie Ihrem neuen CDK-Stack einen Namen geben möchten. Im Folgenden finden Sie ein Beispiel, das eine neue CDK-App erstellt TypeScript , die einen myCloudFormationStack Stack aus einer lokalen template.json Datei enthält:

$ cdk migrate --stack-name "myCloudFormationStack" --language typescript --from-path "./template.json"

Einfaches Beispiel für die Migration von bereitgestellten Ressourcen AWS

Migrieren Sie bereitgestellte AWS Ressourcen aus einer bestimmten AWS Umgebung, die keinem CloudFormation Stack zugeordnet sind, mithilfe von--from-scan. Die CDK-CLI verwendet die IaC generator Dienst, um nach Ressourcen zu suchen und eine Vorlage zu generieren. Anschließend verweist die CDK-CLI auf die Vorlage, um die neue CDK-App zu erstellen. Im Folgenden finden Sie ein Beispiel, das eine neue CDK-App TypeScript mit einem neuen myCloudFormationStack Stack erstellt, der migrierte Ressourcen enthält: AWS 

$ cdk migrate --language typescript --from-scan --stack-name "myCloudFormationStack"