cdk import - AWS Cloud Development Kit (AWS CDK) v2
UtilisationArgumentsOptions

Ceci est le guide du AWS CDK développeur de la version 2. 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 import

Utilisez les importations de AWS CloudFormation ressources pour importer AWS des ressources existantes dans une pile CDK.

Avec cette commande, vous pouvez prendre des ressources existantes créées à l'aide d'autres méthodes et commencer à les gérer à l'aide du AWS CDK.

Lorsque vous envisagez de transférer des ressources vers la gestion des CDK, il est parfois acceptable de créer de nouvelles ressources, par exemple avec les rôles IAM, les fonctions Lambda et les règles d'événements. Pour les autres ressources, telles que les ressources dynamiques telles que les compartiments Amazon S3 et les tables DynamoDB, la création de nouvelles ressources peut avoir un impact sur votre service. Vous pouvez l'utiliser cdk import pour importer des ressources existantes en perturbant le moins possible vos services. Pour obtenir la liste des AWS ressources prises en charge, consultez la section Support des types de ressources dans le guide de AWS CloudFormation l'utilisateur.

Pour importer une ressource existante dans une pile CDK

  1. Exécutez un cdk diff pour vous assurer que votre pile de CDK ne contient aucune modification en attente. Lors de l'exécution d'une opération d'importationcdk import, les seules modifications autorisées sont l'ajout de nouvelles ressources importées.

  2. Ajoutez des structures pour les ressources que vous souhaitez importer dans votre pile. Par exemple, ajoutez ce qui suit pour un compartiment Amazon S3 :

    new s3.Bucket(this, 'ImportedS3Bucket', {});

    N'ajoutez aucune autre modification. Vous devez également vous assurer de modéliser exactement l'état actuel de la ressource. Pour l'exemple du compartiment, veillez à inclure AWS KMS les clés, les politiques de cycle de vie et tout ce qui est pertinent concernant le compartiment. Dans le cas contraire, les opérations de mise à jour suivantes risquent de ne pas donner les résultats escomptés.

  3. Exécutez cdk import. S'il existe plusieurs piles dans l'application CDK, transmettez un nom de pile spécifique en tant qu'argument.

  4. Le CDK vous CLI demandera de transmettre les noms réels des ressources que vous importez. Une fois que vous aurez fourni ces informations, l'importation commencera.

  5. En cas de réussite des cdk import rapports, la ressource sera gérée par le CDK. Toute modification ultérieure de la configuration de construction sera répercutée sur la ressource.

Cette fonctionnalité présente actuellement les limitations suivantes :

  • Il n'est pas possible d'importer des ressources dans des piles imbriquées.

  • Rien ne permet de vérifier si les propriétés que vous spécifiez sont correctes et complètes pour la ressource importée. Essayez de démarrer une opération de détection de dérive après l'importation.

  • Les ressources qui dépendent d'autres ressources doivent toutes être importées ensemble, ou individuellement, dans le bon ordre. Dans le cas contraire, le CloudFormation déploiement échouera avec des références non résolues.

  • Cette commande utilise les informations d'identification du rôle de déploiement, qui sont nécessaires pour lire le bucket intermédiaire chiffré. Cela nécessite la version 12 du modèle bootstrap, qui inclut les autorisations IAM nécessaires pour le rôle de déploiement.

Utilisation

$ cdk import <arguments> <options>

Arguments

ID logique de la pile CDK

ID logique de la pile CDK de votre application vers laquelle vous souhaitez importer les ressources. Cet argument peut être fourni plusieurs fois dans une seule commande.

Type : chaîne

Obligatoire : non

Options

Pour obtenir la liste des options globales qui fonctionnent avec toutes les CLI commandes CDK, consultezOptions globales.

--change-set-name STRING

Nom du jeu de CloudFormation modifications à créer.

--execute BOOLEAN

Spécifiez s'il faut exécuter l'ensemble de modifications.

Valeur par défaut : true

--force, -f BOOLEAN

Par défaut, le CDK CLI quitte le processus si le modèle diff inclut des mises à jour ou des suppressions. Spécifiez true de remplacer ce comportement et de toujours poursuivre l'importation.

--help, -h BOOLEAN

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

--record-resource-mapping, -r STRING

Utilisez cette option pour générer un mappage des ressources physiques existantes avec les ressources CDK qui seront importées. Le mappage sera écrit dans le chemin du fichier que vous avez indiqué. Aucune opération d'importation réelle ne sera effectuée.

--resource-mapping, -m STRING

Utilisez cette option pour spécifier un fichier qui définit le mappage de vos ressources. Le CDK CLI utilisera ce fichier pour mapper les ressources physiques aux ressources à importer au lieu de vous le demander de manière interactive.

Cette option peut être exécutée à partir de scripts.

--rollback BOOLEAN

Ramenez la pile à un état stable en cas de défaillance.

Pour le spécifierfalse, vous pouvez utiliser --no-rollback ou-R.

Spécifiez false pour itérer plus rapidement. Les déploiements contenant des remplacements de ressources échoueront toujours.

Valeur par défaut : true

--toolkit-stack-name STRING

Le nom de la pile CDK Toolkit à créer