Référence des commandes CLI AWS CDK - AWS Cloud Development Kit (AWS CDK) v2
UtilisationCommandesOptions globalesFourniture et configuration d'optionsPasser des options en ligne de commande

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.

Référence des commandes CLI AWS CDK

Cette section contient des informations de référence de AWS Cloud Development Kit (AWS CDK) commande pour l'interface de ligne de commande (CLI). Le CDK CLI est également appelé CDK Toolkit.

Utilisation

$ cdk <command> <arguments> <options>

Commandes

acknowledge, ack

Accusez réception d'un avis par numéro de problème et empêchez-le de s'afficher à nouveau.

bootstrap

Préparez un AWS environnement pour les déploiements de CDK en déployant la pile de bootstrap CDK, nomméeCDKToolkit, dans l'environnement. AWS

context

Gérez les valeurs de contexte mises en cache pour votre application CDK.

deploy

Déployez une ou plusieurs piles de CDK dans votre AWS environnement.

destroy

Supprimez une ou plusieurs piles de CDK de votre AWS environnement.

diff

Effectuez une comparaison pour voir les changements d'infrastructure entre les piles de CDK.

docs, doc

Ouvrez la documentation du CDK dans votre navigateur.

doctor

Inspectez et affichez des informations utiles sur votre projet CDK local et votre environnement de développement.

import

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

init

Créez un nouveau projet CDK à partir d'un modèle.

list, ls

Répertoriez toutes les piles de CDK et leurs dépendances à partir d'une application CDK.

metadata

Afficher les métadonnées associées à une pile de CDK.

migrate

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

notices

Afficher les notifications relatives à votre application CDK.

synthesize, synth

Synthétisez une application CDK pour produire un assemblage cloud, y compris un AWS CloudFormation modèle pour chaque pile.

watch

Surveillez en permanence un projet CDK local pour détecter les modifications nécessaires aux déploiements et aux hotswaps.

Options globales

Les options suivantes sont compatibles avec toutes les CLI commandes CDK.

--app, -a STRING

Fournissez la commande pour exécuter votre application ou votre répertoire d'assemblage cloud.

Obligatoire : oui

--asset-metadata BOOLEAN

Incluez aws:asset:* AWS CloudFormation des métadonnées pour les ressources qui utilisent des actifs.

Obligatoire : non

Valeur par défaut : true

--build STRING

Commande permettant d'exécuter une version de pré-synthèse.

Obligatoire : non

--ca-bundle-path STRING

Chemin d'accès à un certificat CA à utiliser lors de la validation des requêtes HTTPS.

Si cette option n'est pas fournie, le CDK CLI lira la variable d'AWS_CA_BUNDLEenvironnement.

Obligatoire : oui

--ci BOOLEAN

Indiquez que CLI les commandes CDK sont exécutées dans un environnement d'intégration continue (CI).

Cette option modifie le comportement du CDK CLI afin de mieux s'adapter aux opérations automatisées typiques des pipelines CI.

Lorsque vous fournissez cette option, les journaux sont envoyés à la stdout place destderr.

Obligatoire : non

Valeur par défaut : false

--context, -c ARRAY

Ajoutez des paramètres de chaîne contextuels sous forme de paires clé-valeur.

--debug BOOLEAN

Activez les informations de débogage détaillées. Cette option produit une sortie détaillée qui inclut beaucoup plus de détails sur ce que CLI fait le CDK dans les coulisses.

Obligatoire : non

Valeur par défaut : false

--ec2creds, -i BOOLEAN

Forcez le CDK CLI à essayer de récupérer les informations d'identification de l'instance Amazon EC2.

Par défaut, le CDK CLI devine le statut de l'instance Amazon EC2.

Obligatoire : non

Valeur par défaut : false

--help, -h BOOLEAN

Afficher les informations de référence des commandes pour le CDK. CLI

Obligatoire : non

Valeur par défaut : false

--ignore-errors BOOLEAN

Ignorez les erreurs de synthèse, qui produiront probablement une sortie non valide.

Obligatoire : non

Valeur par défaut : false

--json, -j BOOLEAN

Utilisez JSON au lieu de YAML pour les AWS CloudFormation modèles imprimés sur une sortie standard (stdout).

Obligatoire : non

Valeur par défaut : false

--lookups BOOLEAN

Effectuez des recherches contextuelles.

La synthèse échouera si cette valeur est valide false et que des recherches de contexte doivent être effectuées.

Obligatoire : non

Valeur par défaut : true

--no-color BOOLEAN

Supprimez la couleur et les autres styles de la sortie de la console.

Obligatoire : non

Valeur par défaut : false

--notices BOOLEAN

Afficher les avis pertinents.

Obligatoire : non

Valeur par défaut : false

--output, -o STRING

Spécifiez le répertoire vers lequel envoyer l'assemblage cloud synthétisé.

Obligatoire : oui

Valeur par défaut : cdk.out

--path-metadata BOOLEAN

Incluez aws::cdk::path AWS CloudFormation des métadonnées pour chaque ressource.

Obligatoire : non

Valeur par défaut : true

--plugin, -p ARRAY

Nom ou chemin d'un node package qui étend les fonctionnalités du CDK. Cette option peut être fournie plusieurs fois en une seule commande.

Vous pouvez configurer cette option dans le cdk.json fichier du projet ou ~/.cdk.json sur votre machine de développement locale :

{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}

Obligatoire : non

--profile STRING

Spécifiez le nom du AWS profil, contenant les informations relatives à votre AWS environnement, à utiliser avec le CDKCLI.

Obligatoire : oui

--proxy STRING

Utilisez le proxy indiqué.

Si cette option n'est pas fournie, le CDK CLI lira la variable d'HTTPS_PROXYenvironnement.

Obligatoire : oui

Valeur par défaut : Lire à partir de la variable d'HTTPS_PROXYenvironnement.

--role-arn, -r STRING

L'ARN du rôle IAM que le CDK CLI assumera lors de ses interactions. AWS CloudFormation

Obligatoire : non

--staging BOOLEAN

Copiez les actifs dans le répertoire de sortie.

Spécifiez false pour empêcher la copie des actifs dans le répertoire de sortie. Cela permet de AWS SAM CLI référencer les fichiers source d'origine lors du débogage local.

Obligatoire : non

Valeur par défaut : true

--strict BOOLEAN

Ne créez pas de piles contenant des avertissements.

Obligatoire : non

Valeur par défaut : false

--trace BOOLEAN

Imprimer une trace pour les avertissements relatifs à la pile.

Obligatoire : non

Valeur par défaut : false

--verbose, -v COUNT

Afficher les journaux de débogage. Vous pouvez spécifier cette option plusieurs fois pour augmenter la verbosité.

Obligatoire : non

--version BOOLEAN

Afficher le numéro de CLI version du CDK.

Obligatoire : non

Valeur par défaut : false

--version-reporting BOOLEAN

Incluez la AWS::CDK::Metadata ressource dans des AWS CloudFormation modèles synthétisés.

Obligatoire : non

Valeur par défaut : true

Fourniture et configuration d'options

Vous pouvez transmettre des options via des arguments de ligne de commande. Pour la plupart des options, vous pouvez les configurer dans un fichier cdk.json de configuration. Lorsque vous utilisez plusieurs sources de configuration, le CDK CLI respecte la priorité suivante :

  1. Valeurs de ligne de commande — Toute option fournie sur la ligne de commande remplace les options configurées dans les fichiers. cdk.json

  2. Fichier de configuration du projet : cdk.json fichier situé dans le répertoire de votre projet CDK.

  3. Fichier de configuration utilisateur : cdk.json fichier situé ~/.cdk.json sur votre ordinateur local.

Passer des options en ligne de commande

Transmission de valeurs booléennes

Pour les options qui acceptent une valeur booléenne, vous pouvez les spécifier de la manière suivante :

  • Utilisation true et false valeurs — Fournissez la valeur booléenne avec la commande. Voici un exemple :

    $ cdk deploy --watch=true
$ cdk deploy --watch=false

  • Fournir la contrepartie de l'option : modifiez le nom de l'option en ajoutant no pour spécifier une false valeur. Voici un exemple :

    $ cdk deploy --watch
$ cdk deploy --no-watch

  • Pour les options dont la valeur par défaut est true oufalse, vous n'êtes pas obligé de fournir l'option, sauf si vous souhaitez modifier la valeur par défaut.