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 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 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 Stapel enthält, der mit dem Wert benannt ist, den Sie angeben. --stack-name Sie können die Migrationsquelle mit --from-scan--from-stack, oder --from-path konfigurieren.

Weitere Informationen zur Verwendung finden cdk migrate Sie unterMigrieren Sie bestehende Ressourcen und AWS CloudFormation Vorlagen auf die 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 CLI CDK-Befehlen funktionieren, finden Sie unterGlobale 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 der letzte erfolgreiche Scan verwendet werden AWS CDK CLI soll.

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

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: Das AWS CDK CLI ruft Kontoinformationen aus Standardquellen ab.

--compress BOOLEAN

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

Required: No

--filter ARRAY

Wird verwendet, wenn bereitgestellte Ressourcen von einem AWS Konto migriert werden und. AWS-Region 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. z. B. 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. z. B. tag-key="myTagKey".

  • tag-value— Der Wert eines Ressourcen-Tags. z. B. 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 der AWS CDK CLI Ihr aktuelles Arbeitsverzeichnis.

--region STRING

Das AWS-Region , aus dem die AWS CloudFormation Stack-Vorlage abgerufen werden soll.

Required: No

Standard: Der AWS CDK CLI ruft AWS-Region Informationen aus Standardquellen ab.

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 erstelltTypeScript, 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. Das CDK CLI verwendet den IaC generator Dienst, um nach Ressourcen zu suchen und eine Vorlage zu generieren. Anschließend CLI verweist das CDK 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"