cdk migrate - AWS Kit de développement Cloud (AWS CDK) v2
UtilisationOptionsExemples

Ceci est le guide du développeur du AWS CDK v2. L'ancien CDK v1 est entré 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.

cdk migrate

Migrez AWS les ressources, les AWS CloudFormation piles et les CloudFormation modèles déployés vers un nouveau projet AWS CDK.

Cette commande crée une nouvelle application CDK qui inclut une pile unique nommée avec la valeur que vous fournissez à l'aide --stack-name de cette commande. Vous pouvez configurer la source de migration à l'aide de --from-scan--from-stack, ou--from-path.

Pour plus d'informations sur l'utilisationcdk migrate, voir Migrer les ressources et les AWS CloudFormation modèles existants vers le AWS CDK.

Note

La cdk migrate commande est expérimentale et pourrait subir des modifications importantes à l'avenir.

Utilisation

$ cdk migrate <options>

Options

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section Options globales.

Options requises

--stack-name <STRING>

Nom de la AWS CloudFormation pile qui sera créée dans l'application CDK après la migration.

Obligatoire : oui

Options conditionnelles

--from-path <PATH>

Le chemin d'accès au AWS CloudFormation modèle à migrer. Fournissez cette option pour spécifier un modèle local.

Obligatoire : selon les conditions. Obligatoire en cas de migration à partir d'un AWS CloudFormation modèle local.

--from-scan <STRING>

Lorsque vous migrez des ressources déployées depuis un AWS environnement, utilisez cette option pour spécifier si une nouvelle analyse doit être lancée ou si la AWS CLI CDK doit utiliser la dernière analyse réussie.

Obligatoire : selon les conditions. Nécessaire lors de la migration à partir de AWS ressources déployées.

Valeurs acceptées :most-recent, new

--from-stack <BOOLEAN>

Fournissez cette option pour migrer à partir d'une AWS CloudFormation pile déployée. --stack-nameÀ utiliser pour spécifier le nom de la AWS CloudFormation pile déployée.

Obligatoire : selon les conditions. Obligatoire en cas de migration depuis une AWS CloudFormation pile déployée.

Options facultatives

--account <STRING>

Le compte à partir duquel récupérer le modèle de AWS CloudFormation pile.

Obligatoire : non

Par défaut : la CLI AWS CDK obtient les informations de compte à partir de sources par défaut.

--compress <BOOLEAN>

Fournissez cette option pour compresser le projet CDK généré dans un ZIP fichier.

Obligatoire : non

--filter <ARRAY>

À utiliser lors de la migration des ressources déployées depuis un AWS compte et une AWS région. Cette option spécifie un filtre pour déterminer les ressources déployées à migrer.

Cette option accepte un tableau de paires clé-valeur, où la clé représente le type de filtre et la valeur représente la valeur à filtrer.

Les clés suivantes sont acceptées :

  • resource-identifier— Identifiant de la ressource. La valeur peut être l'identifiant logique ou physique de la ressource. Par exemple, resource-identifier="ClusterName".

  • resource-type-prefix— Le préfixe du type de AWS CloudFormation ressource. Par exemple, spécifiez resource-type-prefix="AWS::DynamoDB::" de filtrer toutes les ressources Amazon DynamoDB.

  • tag-key— La clé d'une balise de ressource. Par exemple, tag-key="myTagKey".

  • tag-value— La valeur d'une balise de ressource. Par exemple, tag-value="myTagValue".

Fournissez plusieurs paires clé-valeur pour la logique AND conditionnelle. L'exemple suivant filtre toute ressource DynamoDB étiquetée myTagKey avec comme clé de balise :. --filter resource-type-prefix="AWS::DynamoDB::", tag-key="myTagKey"

Fournissez l'--filteroption plusieurs fois dans une seule commande pour la logique OR conditionnelle. L'exemple suivant filtre toute ressource qui est une ressource DynamoDB ou qui est étiquetée comme clé myTagKey de balise :. --filter resource-type-prefix="AWS::DynamoDB::" --filter tag-key="myTagKey"

Obligatoire : non

--help, -h <BOOLEAN>

Afficher les informations de référence relatives à la cdk migrate commande.

--language <STRING>

Langage de programmation à utiliser pour le projet CDK créé lors de la migration.

Obligatoire : non

Valeurs valides :typescript,python,java,csharp,go.

Par défaut : typescript

--output-path <PATH>

Le chemin de sortie pour le projet CDK migré.

Obligatoire : non

Par défaut : par défaut, la CLI AWS CDK utilisera votre répertoire de travail actuel.

--region <STRING>

La AWS région à partir de laquelle récupérer le modèle de AWS CloudFormation pile.

Obligatoire : non

Par défaut : la CLI AWS CDK obtient les informations de AWS région à partir de sources par défaut.

Exemples

Exemple simple de migration à partir d'une pile CloudFormation

Migrez à partir d'une CloudFormation pile déployée dans un AWS environnement spécifique à l'aide de--from-stack. Indiquez --stack-name le nom de votre nouvelle pile de CDK. Voici un exemple de migration myCloudFormationStack vers une nouvelle application CDK qui utilise : TypeScript

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

Exemple simple de migration à partir d'un modèle local CloudFormation

Migrez à partir d'un CloudFormation modèle JSON ou YAML local à l'aide --from-path de. Indiquez --stack-name le nom de votre nouvelle pile de CDK. Voici un exemple de création d'une nouvelle application CDK TypeScript qui inclut une myCloudFormationStack pile provenant d'un template.json fichier local :

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

Exemple simple de migration à partir de ressources déployées AWS

Migrez AWS les ressources déployées depuis un AWS environnement spécifique qui ne sont pas associées à une CloudFormation pile à l'aide de--from-scan. La CLI CDK utilise IaC generator service permettant de rechercher des ressources et de générer un modèle. Ensuite, la CLI CDK référence le modèle pour créer la nouvelle application CDK. Voici un exemple qui crée une nouvelle application CDK TypeScript avec une nouvelle myCloudFormationStack pile contenant des ressources migrées AWS  :

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