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.

Migrieren Sie vorhandene Ressourcen und AWS CloudFormation Vorlagen auf die AWS CDK

Verwenden Sie die AWS Cloud Development Kit (AWS CDK) Befehlszeilenschnittstelle (AWS CDK CLI), um bereitgestellte AWS Ressourcen, bereitgestellte AWS CloudFormation Stacks und lokale AWS CloudFormation Vorlagen zu AWS CDK migrieren.

Wie funktioniert die Migration

Verwenden Sie die AWS CDK CLI cdk migrateBefehl, um aus den folgenden Quellen zu migrieren:

Nach der Migration können Sie Ihre CDK App verwalten, ändern und bereitstellen, AWS CloudFormation um Ihre Ressourcen bereitzustellen oder zu aktualisieren.

Vorteile von Migrate CDK

Die Migration von Ressourcen AWS CDK war in der Vergangenheit ein manueller Prozess, der Zeit und Fachwissen erforderte, AWS CDK bis er überhaupt begonnen werden konnte. AWS CloudFormation Mit CDK Migrate AWS CDK CLI erleichtert Ihnen einen Großteil des Migrationsaufwands in einem Bruchteil der Zeit. CDKMit Migrate können Sie schnell mit der AWS CDK Entwicklung und Verwaltung neuer und vorhandener Anwendungen beginnen AWS.

Überlegungen

Allgemeine Überlegungen

Überlegungen bei der Migration von einer Vorlage AWS CloudFormation

Überlegungen bei der Migration von bereitgestellten Ressourcen

Voraussetzungen

Bevor Sie den cdk migrate Befehl verwenden, führen Sie alle Einrichtungsschritte unter durchErste Schritte mit dem AWS CDK.

Beginnen Sie mit CDK Migrate

Führen Sie zunächst den AWS CDK CLI cdk migrateBefehl aus einem Verzeichnis Ihrer Wahl. Geben Sie je nach Art der Migration, die Sie durchführen, die erforderlichen und optionalen Optionen an.

Eine vollständige Liste und Beschreibung der Optionen, die Sie zusammen verwenden könnencdk migrate, finden Sie untercdk migrate.

Im Folgenden sind einige wichtige Optionen aufgeführt, die Sie möglicherweise bereitstellen möchten.

Migrieren Sie von einem AWS CloudFormation Stack

Um von einem bereitgestellten AWS CloudFormation Stack zu migrieren, geben Sie die --from-stack Option an. Geben Sie den Namen Ihres bereitgestellten AWS CloudFormation Stacks mit ein--stack-name. Im Folgenden wird ein Beispiel gezeigt:

$ cdk migrate --from-stack --stack-name "myCloudFormationStack"

Der AWS CDK CLI wird Folgendes tun:

Wenn Sie von einem bereitgestellten AWS CloudFormation Stack migrieren, AWS CDK CLI versucht, die bereitgestellte Ressource logisch IDs und den bereitgestellten AWS CloudFormation Stacknamen den migrierten Ressourcen und dem Stack in der neuen CDK App zuzuordnen.

Nach der Migration können Sie Ihre CDK App normal verwalten und ändern. Bei der Bereitstellung AWS CloudFormation wird die Bereitstellung aufgrund des passenden AWS CloudFormation Stack-Namens als AWS CloudFormation Stack-Update identifiziert. Ressourcen mit IDs übereinstimmender Logik werden aktualisiert. Weitere Informationen zur Bereitstellung finden Sie unterVerwalte und bereitstelle deine CDK App bereit.

Aus einer AWS CloudFormation Vorlage migrieren

CDKMigrate unterstützt die Migration von AWS CloudFormation Vorlagen, die in JSON oder formatiert sind. YAML

Um von einer lokalen AWS CloudFormation Vorlage zu migrieren, verwenden Sie die --from-path Option und geben Sie einen Pfad zur lokalen Vorlage an. Sie müssen auch die erforderliche --stack-name Option angeben. Im Folgenden wird ein Beispiel gezeigt:

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

Die AWS CDK CLI wird Folgendes tun:

Nach der Migration können Sie Ihre CDK App normal verwalten und ändern. Bei der Bereitstellung haben Sie die folgenden Optionen:

Migrieren Sie von einer AWS SAM Vorlage

Um von einer AWS Serverless Application Model (AWS SAM) -Vorlage zu migrieren, müssen Sie sie zuerst in eine AWS CloudFormation Vorlage konvertieren oder bereitstellen, um einen AWS CloudFormation Stack zu erstellen.

Um eine AWS SAM Vorlage in zu konvertieren AWS CloudFormation, können Sie den AWS SAM CLI sam validate --debugBefehl. Möglicherweise müssen Sie false in Ihrer samconfig.toml Datei lint auf einstellen, bevor Sie diesen Befehl ausführen können.

Um sie in einen AWS CloudFormation Stapel zu konvertieren, stellen Sie die AWS SAM Vorlage mithilfe des AWS SAM CLI. Migrieren Sie dann vom bereitgestellten Stack.

Migrieren Sie von bereitgestellten Ressourcen

Um von bereitgestellten AWS Ressourcen zu migrieren, geben Sie die --from-scan Option an. Sie müssen auch die erforderliche --stack-name Option angeben. Im Folgenden wird ein Beispiel gezeigt:

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

Die AWS CDK CLI wird Folgendes tun:

Verwenden Sie Filter

Standardmäßig ist der AWS CDK CLI scannt die gesamte AWS Umgebung und migriert Ressourcen bis zur maximalen Kontingentgrenze des IaC-Generators. Sie können Filter mit dem bereitstellen AWS CDK CLI um Kriterien festzulegen, nach denen Ressourcen von Ihrem Konto zur neuen CDK App migriert werden. Weitere Informationen hierzu finden Sie unter --filter.

Mit dem IaC-Generator nach Ressourcen suchen

Abhängig von der Anzahl der Ressourcen in Ihrem Konto kann das Scannen einige Minuten dauern. Während des Scanvorgangs wird ein Fortschrittsbalken angezeigt.

Löst Eigenschaften auf, die nur über Schreibzugriff verfügen

Einige unterstützte Ressourcen enthalten schreibgeschützte Eigenschaften. In diese Eigenschaften kann geschrieben werden, um die Eigenschaft zu konfigurieren, sie können jedoch nicht vom IaC-Generator gelesen oder AWS CloudFormation der Wert abgerufen werden. Beispielsweise kann eine Eigenschaft, die zur Angabe eines Datenbankkennworts verwendet wird, aus Sicherheitsgründen schreibgeschützt sein.

Beim Scannen von Ressourcen während der Migration erkennt der IaC-Generator Ressourcen, die möglicherweise schreibgeschützte Eigenschaften enthalten, und kategorisiert sie in einen der folgenden Typen:

Weitere Informationen zu schreibgeschützten Eigenschaften und dazu, wie IaC Generator sie verwaltet, wenn nach bereitgestellten Ressourcen gesucht und AWS CloudFormation Vorlagen erstellt werden, finden Sie unter IaC-Generator und schreibgeschützte Eigenschaften im Benutzerhandbuch.AWS CloudFormation

Nach der Migration müssen Sie in der neuen App Eigenschaftswerte mit Schreibschutz angeben. CDK Die AWS CDK CLI fügt der CDK ReadMe Projektdatei einen Abschnitt mit Warnungen an, um alle schreibgeschützten Eigenschaften zu dokumentieren, die vom IaC-Generator identifiziert wurden. Im Folgenden wird ein Beispiel gezeigt:

# Welcome to your CDK TypeScript project
...
## Warnings
### Write-only properties
Write-only properties are resource property values that can be written to but can't be read by AWS CloudFormation or CDK Migrate. For more information, see [IaC generator and write-only properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html).

Write-only properties discovered during migration are organized here by resource ID and categorized by write-only property type. Resolve write-only properties by providing property values in your CDK app. For guidance, see [Resolve write-only properties](https://docs.aws.amazon.com/cdk/v2/guide/migrate.html#migrate-resources-writeonly).
### MyLambdaFunction
- **UNSUPPORTED_PROPERTIES**: 
  - SnapStart/ApplyOn: Applying SnapStart setting on function resource type.Possible values: [PublishedVersions, None]
This property can be replaced with other types
  - Code/S3ObjectVersion: For versioned objects, the version of the deployment package object to use.
This property can be replaced with other exclusive properties
- **MUTUALLY_EXCLUSIVE_PROPERTIES**: 
  - Code/S3Bucket: An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
This property can be replaced with other exclusive properties
  - Code/S3Key: The Amazon S3 key of the deployment package.
This property can be replaced with other exclusive properties

Sobald Sie alle Eigenschaftswerte für schreibgeschützte Eigenschaften aufgelöst haben, können Sie sich auf die Bereitstellung vorbereiten.

Die Datei migrate.json

Die AWS CDK CLI erstellt während der Migration eine migrate.json Datei in Ihrem AWS CDK Projekt. Diese Datei enthält Referenzinformationen zu Ihren bereitgestellten Ressourcen. Wenn Sie Ihre CDK App zum ersten Mal bereitstellen, AWS CDK CLI verwendet diese Datei, um auf Ihre bereitgestellten Ressourcen zu verweisen, ordnet Ihre Ressourcen dem neuen AWS CloudFormation Stack zu und löscht die Datei.

Verwalte und bereitstelle deine CDK App bereit

Bei der Migration zu AWS CDK ist die neue CDK App möglicherweise nicht sofort einsatzbereit. In diesem Thema werden Maßnahmen beschrieben, die Sie bei der Verwaltung und Bereitstellung Ihrer neuen App berücksichtigen sollten. CDK

Bereiten Sie sich auf die Bereitstellung vor

Vor der Bereitstellung müssen Sie Ihre CDK App vorbereiten.

Stellen Sie Ihre CDK App bereit

Wenn Sie eine CDK App bereitstellen, AWS CDK CLI nutzt den AWS CloudFormation Service, um Ihre Ressourcen bereitzustellen. Ressourcen werden in der CDK App in einem einzigen Stapel gebündelt und als einziger AWS CloudFormation Stapel bereitgestellt.

Je nachdem, von wo aus Sie migriert haben, können Sie die Bereitstellung verwenden, um einen neuen AWS CloudFormation Stack zu erstellen oder einen vorhandenen AWS CloudFormation Stack zu aktualisieren.