cdk refactor - AWS Kit de développement Cloud (AWS CDK) v2
UtilisationArgumentsOptions

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 refactor

Important

La cdk refactor commande est en version préliminaire et est sujette à modification.

Vous devez fournir cette --unstable=refactor option lorsque vous utilisez cette commande.

Préservez les ressources déployées lors de la refactorisation du code dans votre AWS application Cloud Development Kit (AWS CDK).

Lorsque vous renommez des constructions ou que vous les déplacez d'une pile à l'autre dans votre code CDK, vous les CloudFormation traitez généralement comme de nouvelles ressources, ce qui entraîne des remplacements susceptibles d'entraîner des interruptions de service ou des pertes de données. La cdk refactor commande détecte intelligemment ces modifications et fonctionne avec CloudFormation l'API de refactorisation pour préserver vos ressources tout en actualisant leur logique. IDs

Grâce à cdk refactor, vous pouvez :

  • Renommez les constructions pour améliorer la clarté de votre base de code sans entraîner le remplacement des ressources.

  • Déplacez les ressources entre les piles pour améliorer l'organisation et la séparation des préoccupations.

  • Réorganisez votre hiérarchie de construction (par exemple en regroupant les ressources AWS sous une nouvelle structure L3) tout en préservant les ressources cloud sous-jacentes.

  • Mettez à niveau ou passez d'une bibliothèque de construction à une autre en toute sécurité, y compris les dépendances tierces, sans déclencher le remplacement des ressources en cas de IDs changement logique entre les versions.

Cette commande analyse vos modifications, affiche une liste des ressources qui changeront d'emplacement (pile et ID logique) et gère le processus complexe de mise à jour des CloudFormation ressources tout en conservant leur identité et leur état.

Lorsqu'elle est exécutée, la commande calcule automatiquement les mappages en comparant votre code actuel avec l'état déployé. Il vérifie que votre application CDK contient exactement le même ensemble de ressources que l'état déployé, les différences se limitant à leur emplacement dans l'arbre de construction. Si la commande détecte des ajouts, des suppressions ou des modifications de ressources, l'opération de refactorisation sera rejetée avec un message d'erreur.

Après le calcul du mappage, la commande affiche les modifications proposées et, après confirmation de l'utilisateur, applique le refactoring. Si une ambiguïté est détectée (lorsque plusieurs mappages valides sont possibles), vous pouvez fournir un fichier de remplacement avec des mappages explicites pour résoudre ces cas.

Pour une introduction, voir Préserver les ressources déployées lors de la refactorisation du code CDK.

Utilisation

$ cdk refactor <arguments> <options>

Arguments

ID de pile CDK

L'ID de construction de la pile CDK de votre application à refactoriser.

Vous pouvez spécifier plusieurs piles IDs pour concentrer l'opération de refactorisation sur ces piles. Si des ressources sont déplacées entre des piles et que l'une de ces piles n'est pas explicitement incluse, la commande refactor inclura automatiquement la pile supplémentaire dans l'opération.

Si vous ne fournissez aucune pile IDs, toutes les piles de l'application seront prises en compte pour la refactorisation.

Type : chaîne

Obligatoire : non

Options

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

--dry-run

Imprimez le mappage sur la console sans l'appliquer.

Cette option est utile pour valider vos modifications avant de procéder à la refactorisation, en particulier lorsque vous travaillez avec des applications complexes. Il vous indique exactement quelles modifications seraient apportées sans modifier les ressources.

--force

Procédez à la refactorisation sans demander de confirmation à l'utilisateur.

Cela est utile dans les environnements interactifs lorsque vous êtes sûr des modifications. Dans les environnements non interactifs tels que les CI/CD pipelines, la CLI CDK fonctionne automatiquement sans demande. Cette option n'est donc pas nécessaire.

--help, -h <BOOLEAN>

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

--override-file <FILE>

Fournissez des remplacements lorsque la CLI CDK n'est pas en mesure de déterminer une résolution de refactorisation pour les ressources. Ce fichier contient des mappages de ressources au format JSON. Voici un exemple :

{
    "environments": [
        {
            "account": "123456789012",
            "region": "us-east-2",
            "resources": {
                "StackA.OldName": "StackB.NewName",
                "StackC.Foo": "StackC.Bar"
            }
        }
    ]
}
--revert <FILE>

Annulez un refactor précédent. Vous devez fournir un fichier de remplacement avec les mappages de ressources.

Cela n'annule pas complètement une opération de refactorisation précédente. Pour rétablir complètement un refactor, vous devez rétablir l'état antérieur de votre application et relancer le processus de refactorisation.