View a markdown version of this page

cdk orphan - AWS Kit de développement Cloud (AWS CDK) v2
UsageArgumentsOptionsExemples

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 orphan

Important

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

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

Détachez en toute sécurité une ou plusieurs ressources d'une AWS CloudFormation pile sans les supprimer. Cela est utile lorsque vous devez migrer une ressource d'un type de construction à un autre (par exemple, migrer un Table DynamoDB TableV2 vers) sans interruption ni perte de données.

Lorsque vous modifiez un type de construction dans votre code CDK, il l' CloudFormation interprète comme un remplacement de ressource, ce qui supprime la ressource existante et en crée une nouvelle. Pour les ressources dynamiques telles que les bases de données et le stockage, cela entraîne une perte de données. La cdk orphan commande résout ce problème en détachant d'abord la ressource de la pile, afin que vous puissiez la réimporter sous le nouveau type de construction en utilisant. cdk import

Grâce à cdk orphan, vous pouvez :

  • Détachez les ressources dynamiques d'une pile avant de modifier leur type de construction.

  • Migrez entre les versions de construction (par exemple, Table DynamoDB TableV2 vers) sans perte de données.

  • Modifiez le type de CloudFormation ressource qui soutient une construction sans remplacer la ressource physique.

La commande orphan effectue trois CloudFormation déploiements :

  1. Résoudre les références : résout les références croisées (RefFn::GetAtt,,Fn::Sub) aux ressources orphelines, afin que les autres ressources de la pile qui en dépendent continuent de fonctionner après la suppression des ressources orphelines.

  2. Découplage : remplace toutes les références entre ressources par leurs valeurs littérales résolues, définit DeletionPolicy et supprime des DependsOn entrées pour isoler les ressources du reste de la pile. Retain

  3. Supprimer : Supprime les ressources du CloudFormation modèle. Les ressources physiques continuent d'exister dans votre AWS compte.

Une fois orphelin, mettez à jour votre code CDK pour utiliser le nouveau type de construction et utilisez l'importation cdk pour remettre la ressource sous gestion.

Pour rendre une ressource orpheline et la réimporter sous un nouveau type de construction

  1. Déployez votre stack et vérifiez que la ressource existe.

  2. Exécutez cdk orphan avec le chemin de construction de la ressource :

    $ cdk orphan MyStack/MyTable --unstable=orphan

  3. La commande produit un mappage des ressources. Enregistrez-le pour l'étape d'importation.

  4. Mettez à jour votre code CDK pour utiliser le nouveau type de construction (par exemple, changez Table enTableV2).

  5. Exécutez cdk import avec le mappage des ressources à partir de la sortie orpheline :

    $ cdk import MyStack --resource-mapping-inline '{"MyTable":{"TableName":"my-table"}}'

  6. Une fois l'importation terminée, cdk import détecte la dérive et vous invite à effectuer le déploiement. Acceptez l'invite de réconciliation de la pile.

Cette fonctionnalité présente actuellement les limitations suivantes :

  • Tous les chemins de construction doivent faire référence à la même pile. La mise en orpheline de ressources sur plusieurs piles en une seule commande n'est pas prise en charge.

  • Les modèles de caractères génériques ne sont pas pris en charge. Les chemins sont mis en correspondance sous forme de préfixes exacts.

  • Cette commande nécessite la version 32 du modèle bootstrap, qui inclut les autorisations IAM nécessaires pour le rôle de déploiement.

Usage

$ cdk orphan <PATHS> <options>

Arguments

CHEMINS

Un ou plusieurs chemins de construction vers l'orphelin, au formatStackName/ConstructPath. Par exemple, MyStack/MyTable. Plusieurs chemins peuvent être fournis pour rendre orphelines plusieurs ressources en une seule commande.

Tous les chemins doivent faire référence à la même pile.

Type : chaîne

Obligatoire : oui

Options

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

--help, -h <BOOLEAN>

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

Exemples

Orphelin, une ressource unique

$ cdk orphan MyStack/MyTable --unstable=orphan

Ressources multiples orphelines

$ cdk orphan MyStack/MyTable MyStack/MyBucket --unstable=orphan

Ignorer l'invite de confirmation

$ cdk orphan MyStack/MyTable --unstable=orphan --yes