cdk watch - AWS Cloud Development Kit (AWS CDK) v2
UtilisationArgumentsOptionsExemples

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.

cdk watch

Surveillez en permanence les modifications apportées à un AWS CDK projet local afin d'effectuer des déploiements et des hotswaps.

Cette commande est similaire àcdk deploy, sauf qu'elle peut effectuer des déploiements continus et des hotswaps via une seule commande.

Cette commande est un raccourci pourcdk deploy --watch.

Pour terminer une cdk watch session, interrompez le processus en appuyant surCtrl+C.

Les fichiers observés sont déterminés par le "watch" paramètre de votre cdk.json fichier. Il possède deux sous-clés "include" et "exclude" accepte une seule chaîne ou un tableau de chaînes. Chaque entrée est interprétée comme un chemin relatif à l'emplacement du cdk.json fichier. Les deux * ** sont acceptés.

Si vous créez un projet à l'aide de la cdk init commande, le comportement par défaut suivant est configuré cdk watch dans le cdk.json fichier de votre projet :

  • "include"est défini sur"**/*", ce qui inclut tous les fichiers et répertoires situés à la racine du projet.

  • "exclude"est facultatif, sauf pour les fichiers et dossiers déjà ignorés par défaut. Il s'agit de fichiers et de répertoires commençant par., le répertoire de CDK sortie et le node_modules répertoire.

Le paramètre minimal à configurer watch est"watch": {}.

Si votre CDK code ou le code de votre application nécessite une étape de compilation avant le déploiement, cdk watch fonctionne avec la "build" clé contenue dans le cdk.json fichier.

Note

Cette commande est considérée comme expérimentale et pourrait subir des modifications importantes à l'avenir.

Les mêmes limites s'cdk deploy --hotswapappliquent àcdk watch. Pour de plus amples informations, veuillez consulter cdk deploy --hotswap.

Utilisation

$ cdk watch <arguments> <options>

Arguments

CDKID de pile

L'ID de construction de la CDK pile indiqué dans votre application à surveiller.

Type : chaîne

Obligatoire : non

Options

Pour une liste des options globales qui fonctionnent avec tous CDK CLI commandes, voirOptions globales.

--build-exclude, -E ARRAY

Ne reconstruisez pas l'actif avec l'ID donné.

Cette option peut être spécifiée plusieurs fois en une seule commande.

Valeur par défaut : []

--change-set-name STRING

Nom du jeu de CloudFormation modifications à créer.

--concurrency NUMBER

Déployez et échangez à chaud plusieurs piles en parallèle tout en tenant compte des dépendances entre piles. Utilisez cette option pour accélérer les déploiements. Vous devez tout de même tenir compte CloudFormation de toute autre limite Compte AWS de taux.

Entrez un nombre pour spécifier le nombre maximum de déploiements simultanés (si la dépendance le permet) à effectuer.

Valeur par défaut : 1

--exclusively, -e BOOLEAN

Déployez uniquement les piles demandées et n'incluez pas les dépendances.

--force, -f BOOLEAN

Déployez toujours des piles, même si les modèles sont identiques.

Valeur par défaut : false

--help, -h BOOLEAN

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

--hotswap BOOLEAN

Par défaut, cdk watch utilise des déploiements hotswap lorsque cela est possible pour mettre à jour vos ressources. Le CDK CLI tentera d'effectuer un déploiement par échange à chaud et ne reviendra pas à un CloudFormation déploiement complet en cas d'échec. Toutes les modifications détectées qui ne peuvent pas être mises à jour via un hotswap sont ignorées.

Valeur par défaut : true

--hotswap-fallback BOOLEAN

Par défaut, cdk watch tente d'effectuer des déploiements par échange à chaud et ignore les modifications qui nécessitent des déploiements. CloudFormation Prévoyez --hotswap-fallback de revenir en arrière et d'effectuer un CloudFormation déploiement complet en cas d'échec du déploiement par hotswap.

--logs BOOLEAN

Par défaut, cdk watch surveille tous les groupes de CloudWatch journaux de votre application et diffuse les événements du journal localement versstdout.

Valeur par défaut : true

--progress STRING

Configurez la façon dont CDK CLI affiche la progression du déploiement.

  • bar— Affichez les événements de déploiement de la pile sous forme de barre de progression, avec les événements relatifs à la ressource en cours de déploiement.

  • events— Fournissez un historique complet, y compris tous les CloudFormation événements.

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

{
   "progress": "events"
}

Valeurs valides : bar, events

Valeur par défaut : bar

--rollback BOOLEAN

Au cours du déploiement, si une ressource ne parvient pas à être créée ou mise à jour, le déploiement reviendra à l'état stable le plus récent avant CDK CLI retours. Toutes les modifications effectuées jusqu'à ce point seront annulées. Les ressources créées seront supprimées et les mises à jour effectuées seront annulées.

Utilisez --no-rollback ou -R pour désactiver ce comportement. Si une ressource ne parvient pas à être créée ou mise à jour, CDK CLI laissera les modifications apportées jusqu'à ce point en place et y retournera. Cela peut être utile dans les environnements de développement dans lesquels vous effectuez des itérations rapides.

Note

À quel momentfalse, les déploiements qui entraînent le remplacement des ressources échoueront toujours. Vous ne pouvez utiliser cette valeur que pour les déploiements qui mettent à jour ou créent de nouvelles ressources.

Valeur par défaut : true

--toolkit-stack-name STRING

Nom de la pile CDK Toolkit existante.

Par défaut, cdk bootstrap déploie une pile nommée CDKToolkit dans l' AWS environnement spécifié. Utilisez cette option pour attribuer un nom différent à votre stack bootstrap.

Le CDK CLI utilise cette valeur pour vérifier la version de votre stack bootstrap.

Exemples

Surveillez les modifications apportées à une CDK pile avec DevelopmentStack un identifiant logique

$ cdk watch DevelopmentStack
Detected change to 'lambda-code/index.js' (type: change). Triggering 'cdk deploy'
DevelopmentStack: deploying...

 ✅  DevelopmentStack

Configuration d'un fichier cdk.json indiquant les éléments à inclure et à exclure de la surveillance des modifications

{
   "app": "mvn -e -q compile exec:java",
   "watch": {
    "include": "src/main/**",
    "exclude": "target/*"
   }
}

Créez un CDK projet en utilisant Java avant le déploiement en configurant le fichier cdk.json

{
  "app": "mvn -e -q exec:java",
  "build": "mvn package",
  "watch": {
    "include": "src/main/**",
    "exclude": "target/*"
  }
}