Ceci est le guide du AWS CDK développeur de la version 2. L'ancienne CDK version 1 est entrée en maintenance le 1er juin 2022 et a pris fin le 1er juin 2023.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Migrez les ressources et les AWS CloudFormation modèles existants vers AWS CDK

Utilisez l'interface AWS Cloud Development Kit (AWS CDK) de ligne de commande (AWS CDK CLI) pour migrer les AWS ressources déployées, les AWS CloudFormation piles déployées et les AWS CloudFormation modèles locaux vers AWS CDK.

Comment fonctionne la migration

Utilisez le AWS CDK CLI cdk migratecommande pour effectuer la migration à partir des sources suivantes :

Après la migration, vous pouvez gérer, modifier et déployer votre CDK application pour approvisionner ou mettre AWS CloudFormation à jour vos ressources.

Avantages de CDK Migrate

La migration des ressources vers ce AWS CDK site a toujours été un processus manuel qui nécessite du temps et de l'expertise, voire même AWS CDK pour commencer. AWS CloudFormation Avec CDK Migrate, le AWS CDK CLI facilite la majeure partie des efforts de migration pour vous en un rien de temps. CDKMigrate vous permettra de commencer rapidement à utiliser le AWS CDK pour développer et gérer des applications nouvelles et existantes sur AWS.

Considérations

Considérations d’ordre général

Considérations relatives à la migration à partir d'un modèle AWS CloudFormation

Considérations relatives à la migration à partir de ressources déployées

Prérequis

Avant d'utiliser la cdk migrate commande, effectuez toutes les étapes de configuration dansCommencer à utiliser le AWS CDK.

Commencez avec CDK Migrate

Pour commencer, lancez AWS CDK CLI cdk migratecommande depuis le répertoire de votre choix. Fournissez les options obligatoires et facultatives, en fonction du type de migration que vous effectuez.

Pour une liste complète et une description des options que vous pouvez utilisercdk migrate, consultezcdk migrate.

Voici quelques options importantes que vous souhaiterez peut-être proposer.

Migrer à partir d'une AWS CloudFormation pile

Pour effectuer une migration à partir d'une AWS CloudFormation pile déployée, offrez l'--from-stackoption. Indiquez le nom de votre AWS CloudFormation stack déployé avec--stack-name. Voici un exemple :

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

Le AWS CDK CLI effectuera les opérations suivantes :

Lorsque vous migrez à partir d'une AWS CloudFormation pile déployée, AWS CDK CLI tente de faire correspondre la logique des ressources déployées IDs et le nom de la AWS CloudFormation pile déployée aux ressources migrées et à la pile dans la nouvelle CDK application.

Après la migration, vous pouvez gérer et modifier votre CDK application normalement. Lorsque vous déployez, AWS CloudFormation identifiera le déploiement comme une mise à jour de AWS CloudFormation pile en raison du nom de AWS CloudFormation pile correspondant. Les ressources associées à la logique correspondante IDs seront mises à jour. Pour plus d'informations sur le déploiement, consultezGérez et déployez votre CDK application.

Migrer à partir d'un AWS CloudFormation modèle

CDKMigrate prend en charge la migration à partir de AWS CloudFormation modèles formatés en JSON ou. YAML

Pour effectuer une migration à partir d'un AWS CloudFormation modèle local, utilisez l'--from-pathoption et indiquez un chemin d'accès au modèle local. Vous devez également fournir l'--stack-nameoption requise. Voici un exemple :

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

Le AWS CDK CLI effectuera les opérations suivantes :

Après la migration, vous pouvez gérer et modifier votre CDK application normalement. Lors du déploiement, vous disposez des options suivantes :

Migrer à partir d'un AWS SAM modèle

Pour migrer depuis un modèle AWS Serverless Application Model (AWS SAM), vous devez d'abord le convertir en AWS CloudFormation modèle ou le déployer pour créer une AWS CloudFormation pile.

Pour convertir un AWS SAM modèle en AWS CloudFormation, vous pouvez utiliser AWS SAM CLI sam validate --debugcommande. Vous devrez peut-être le lint définir false dans votre samconfig.toml fichier avant d'exécuter cette commande.

Pour le convertir en AWS CloudFormation pile, déployez le AWS SAM modèle à l'aide du AWS SAM CLI. Migrez ensuite depuis la pile déployée.

Migrer à partir des ressources déployées

Pour effectuer une migration à partir de AWS ressources déployées, offrez l'--from-scanoption. Vous devez également fournir l'--stack-nameoption requise. Voici un exemple :

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

Le AWS CDK CLI effectuera les opérations suivantes :

Utiliser des filtres

Par défaut, le AWS CDK CLI analysera l'ensemble de AWS l'environnement et migrera les ressources jusqu'à la limite de quota maximale du générateur IaC. Vous pouvez fournir des filtres avec AWS CDK CLI pour spécifier les critères selon lesquels les ressources seront migrées de votre compte vers la nouvelle CDK application. Pour en savoir plus, consultez --filter.

Recherche de ressources avec le générateur IaC

Selon le nombre de ressources de votre compte, la numérisation peut prendre quelques minutes. Une barre de progression s'affiche pendant le processus de numérisation.

Résoudre les propriétés en écriture seule

Certaines ressources prises en charge contiennent des propriétés en écriture seule. Ces propriétés peuvent être écrites pour configurer la propriété, mais ne peuvent pas être lues par le générateur IaC ou AWS CloudFormation pour obtenir la valeur. Par exemple, une propriété utilisée pour spécifier un mot de passe de base de données peut être en écriture seule pour des raisons de sécurité.

Lors de l'analyse des ressources pendant la migration, le générateur iAC détecte les ressources susceptibles de contenir des propriétés en écriture seule et les classe dans l'un des types suivants :

Pour plus d'informations sur les propriétés en écriture seule et sur la façon dont le générateur iAC les gère lors de la recherche de ressources déployées et de la création de AWS CloudFormation modèles, consultez les sections Générateur iAc et propriétés en écriture seule dans le Guide de l'utilisateur.AWS CloudFormation

Après la migration, vous devez spécifier des valeurs de propriétés en écriture seule dans la nouvelle CDK application. Le AWS CDK CLI ajoutera une section Avertissements au ReadMe fichier du CDK projet pour documenter toutes les propriétés en écriture seule identifiées par le générateur IaC. Voici un exemple :

# 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

Une fois que vous avez résolu toutes les valeurs de propriété en écriture seule, vous êtes prêt à préparer le déploiement.

Le fichier migrate.json

Le AWS CDK CLI crée un migrate.json fichier dans votre AWS CDK projet lors de la migration. Ce fichier contient des informations de référence sur vos ressources déployées. Lorsque vous déployez votre CDK application pour la première fois, AWS CDK CLI utilise ce fichier pour référencer vos ressources déployées, associe vos ressources à la nouvelle AWS CloudFormation pile et supprime le fichier.

Gérez et déployez votre CDK application

Lors de la migration vers AWS CDK, il est possible que la nouvelle CDK application ne soit pas immédiatement prête à être déployée. Cette rubrique décrit les actions à prendre en compte lors de la gestion et du déploiement de votre nouvelle CDK application.

Préparation au déploiement

Avant le déploiement, vous devez préparer votre CDK application.

Déployez votre CDK application

Lorsque vous déployez une CDK application, AWS CDK CLI utilise le AWS CloudFormation service pour mettre à disposition vos ressources. Les ressources sont regroupées dans une pile unique dans l'CDKapplication et sont déployées en tant que AWS CloudFormation pile unique.

Selon l'endroit d'où vous avez migré, vous pouvez effectuer un déploiement pour créer une nouvelle AWS CloudFormation pile ou mettre à jour une AWS CloudFormation pile existante.