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.

# AWS Référence de commande CDK CLI
<a name="ref-cli-cmd"></a>

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

## Utilisation
<a name="ref-cli-cmd-usage"></a>

```
$ cdk <command> <arguments> <options>
```

## Commandes
<a name="ref-cli-cmd-commands"></a><a name="ref-cli-cmd-commands-acknowledge"></a>

 ` acknowledge ack `   
Accusez réception d'un avis par numéro de problème et empêchez-le de s'afficher à nouveau.<a name="ref-cli-cmd-commands-bootstrap"></a>

 ` bootstrap `   
Préparez un AWS environnement pour les déploiements de CDK en déployant la pile de bootstrap CDK, nommée`CDKToolkit`, dans l'environnement. AWS <a name="ref-cli-cmd-commands-context"></a>

 ` context `   
Gérez les valeurs de contexte mises en cache pour votre application CDK.<a name="ref-cli-cmd-commands-deploy"></a>

 ` deploy `   
Déployez une ou plusieurs piles de CDK dans votre AWS environnement.<a name="ref-cli-cmd-commands-destroy"></a>

 ` destroy `   
Supprimez une ou plusieurs piles de CDK de votre AWS environnement.<a name="ref-cli-cmd-commands-diff"></a>

 ` diff `   
Effectuez une comparaison pour voir les changements d'infrastructure entre les piles de CDK.<a name="ref-cli-cmd-commands-docs"></a>

 ` docs doc `   
Ouvrez la documentation du CDK dans votre navigateur.<a name="ref-cli-cmd-commands-doctor"></a>

 ` doctor `   
Inspectez et affichez des informations utiles sur votre projet CDK local et votre environnement de développement.<a name="ref-cli-cmd-commands-drift"></a>

 ` drift `   
Détectez les dérives de configuration pour les ressources que vous définissez, gérez et déployez à l'aide du CDK.<a name="ref-cli-cmd-commands-flags"></a>

 ` flags `   
Affichez et modifiez les configurations de vos indicateurs de fonctionnalité pour la CLI CDK.<a name="ref-cli-cmd-commands-import"></a>

 ` import `   
Utilisez les importations de AWS CloudFormation ressources pour importer AWS des ressources existantes dans une pile CDK.<a name="ref-cli-cmd-commands-init"></a>

 ` init `   
Créez un nouveau projet CDK à partir d'un modèle.<a name="ref-cli-cmd-commands-list"></a>

 ` list, ls `   
Répertoriez toutes les piles de CDK et leurs dépendances à partir d'une application CDK.<a name="ref-cli-cmd-commands-metadata"></a>

 ` metadata `   
Afficher les métadonnées associées à une pile de CDK.<a name="ref-cli-cmd-commands-migrate"></a>

 ` migrate `   
Migrez AWS les ressources, AWS CloudFormation les piles et les AWS CloudFormation modèles vers un nouveau projet CDK.<a name="ref-cli-cmd-commands-notices"></a>

 ` notices `   
Afficher les notifications relatives à votre application CDK.<a name="ref-cli-cmd-commands-refactor"></a>

 ` refactor `   
Préservez les ressources déployées lors de la refactorisation du code dans votre application CDK.<a name="ref-cli-cmd-commands-synthesize"></a>

 ` synthesize, synth `   
Synthétisez une application CDK pour produire un assemblage cloud, y compris un AWS CloudFormation modèle pour chaque pile.<a name="ref-cli-cmd-commands-watch"></a>

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

## Options globales
<a name="ref-cli-cmd-options"></a>

Les options suivantes sont compatibles avec toutes les commandes CDK CLI.<a name="ref-cli-cmd-options-app"></a>

 `--app, -a <STRING>`   
Fournissez la commande pour exécuter votre application ou votre répertoire d'assemblage cloud.  
 *Obligatoire* : oui<a name="ref-cli-cmd-options-asset-metadata"></a>

 `--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` <a name="ref-cli-cmd-options-build"></a>

 `--build <STRING>`   
Commande pour exécuter une version de pré-synthèse.  
 *Obligatoire* : non<a name="ref-cli-cmd-options-ca-bundle-path"></a>

 `--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, la CLI CDK lira la variable d'`AWS_CA_BUNDLE`environnement.  
 *Obligatoire* : oui<a name="ref-cli-cmd-options-ci"></a>

 `--ci <BOOLEAN>`   
Indiquez que les commandes CDK CLI sont exécutées dans un environnement d'intégration continue (CI).  
Cette option modifie le comportement de la CLI CDK 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 de`stderr`.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-context"></a>

 `--context, -c <ARRAY>`   
Ajoutez des paramètres de chaîne contextuels sous forme de paires clé-valeur.<a name="ref-cli-cmd-options-debug"></a>

 `--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 fait la CLI CDK en arrière-plan.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-ec2creds"></a>

 `--ec2creds, -i <BOOLEAN>`   
Forcez la CLI CDK à essayer de récupérer les informations d'identification de l' EC2 instance Amazon.  
Par défaut, la CLI CDK devine le statut de l' EC2 instance Amazon.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence des commandes pour la CLI CDK.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-ignore-errors"></a>

 `--ignore-errors <BOOLEAN>`   
Ignorez les erreurs de synthèse, qui produiront probablement une sortie non valide.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-json"></a>

 `--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` <a name="ref-cli-cmd-options-lookups"></a>

 `--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` <a name="ref-cli-cmd-options-no-color"></a>

 `--no-color <BOOLEAN>`   
Supprimez la couleur et les autres styles de la sortie de console.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-notices"></a>

 `--notices <BOOLEAN>`   
Afficher les avis pertinents.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-output"></a>

 `--output, -o <STRING>`   
Spécifiez le répertoire vers lequel envoyer l'assemblage cloud synthétisé.  
 *Obligatoire* : oui  
 *Valeur par défaut* : `cdk.out` <a name="ref-cli-cmd-options-path-metadata"></a>

 `--path-metadata <BOOLEAN>`   
Incluez `aws::cdk::path` AWS CloudFormation des métadonnées pour chaque ressource.  
 *Obligatoire* : non  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-options-plugin"></a>

 `--plugin, -p <ARRAY>`   
Nom ou chemin d'un package de nœud 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<a name="ref-cli-cmd-options-profile"></a>

 `--profile <STRING>`   
Spécifiez le nom du AWS profil, contenant les informations relatives à votre AWS environnement, à utiliser avec la CLI CDK.  
 *Obligatoire* : oui<a name="ref-cli-cmd-options-proxy"></a>

 `--proxy <STRING>`   
Utilisez le proxy indiqué.  
Si cette option n'est pas fournie, la CLI CDK lira la variable d'`HTTPS_PROXY`environnement.  
 *Obligatoire* : oui  
 *Valeur par défaut* : Lire à partir de la variable d'`HTTPS_PROXY`environnement.<a name="ref-cli-cmd-options-role-arn"></a>

 `--role-arn, -r <STRING>`   
L'ARN du rôle IAM que la CLI CDK assumera lors de l'interaction avec. AWS CloudFormation  
 *Obligatoire* : non<a name="ref-cli-cmd-options-staging"></a>

 `--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 à la CLI AWS SAM de référencer les fichiers source d'origine lors du débogage local.  
 *Obligatoire* : non  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-options-strict"></a>

 `--strict <BOOLEAN>`   
Ne créez pas de piles contenant des avertissements.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-trace"></a>

 `--trace <BOOLEAN>`   
Imprimer une trace pour les avertissements relatifs à la pile.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-verbose"></a>

 `--verbose, -v <COUNT>`   
Afficher les journaux de débogage. Vous pouvez spécifier cette option plusieurs fois pour augmenter la verbosité.  
 *Obligatoire* : non<a name="ref-cli-cmd-options-version"></a>

 `--version <BOOLEAN>`   
Afficher le numéro de version de la CLI du CDK.  
 *Obligatoire* : non  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-options-version-reporting"></a>

 `--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
<a name="ref-cli-cmd-configure"></a>

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, la CLI CDK 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`

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

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

## Passer des options en ligne de commande
<a name="ref-cli-cmd-pass"></a><a name="ref-cli-cmd-pass-bool"></a>

 **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` ou`false`, vous n'êtes pas obligé de fournir l'option, sauf si vous souhaitez modifier la valeur par défaut.

# `cdk acknowledge`
<a name="ref-cli-cmd-ack"></a>

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

Cela est utile pour masquer les notifications qui vous ont été adressées ou qui ne vous concernent pas.

Les remerciements sont enregistrés au niveau du projet CDK. Si vous accusez réception d'une notification dans un projet CDK, elle s'affichera toujours dans les autres projets jusqu'à ce qu'elle y soit reconnue.

## Utilisation
<a name="ref-cli-cmd-ack-usage"></a>

```
$ cdk acknowledge <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-ack-args"></a><a name="ref-cli-cmd-ack-args-notice-id"></a>

 **Numéro de l'avis**   
L'ID de l'avis.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-ack-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-ack-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk acknowledge` commande.

## Exemples
<a name="ref-cli-cmd-ack-examples"></a>

### Reconnaître et masquer un avis qui s'affiche lors de l'exécution d'une autre commande CDK CLI
<a name="ref-cli-cmd-ack-examples-1"></a>

```
$ cdk deploy
... # Normal output of the command

NOTICES

16603   Toggling off auto_delete_objects for Bucket empties the bucket

        Overview: If a stack is deployed with an S3 bucket with
                  auto_delete_objects=True, and then re-deployed with
                  auto_delete_objects=False, all the objects in the bucket
                  will be deleted.

        Affected versions: <1.126.0.

        More information at: https://github.com/aws/aws-cdk/issues/16603


17061   Error when building EKS cluster with monocdk import

        Overview: When using monocdk/aws-eks to build a stack containing
                  an EKS cluster, error is thrown about missing
                  lambda-layer-node-proxy-agent/layer/package.json.

        Affected versions: >=1.126.0 <=1.130.0.

        More information at: https://github.com/aws/aws-cdk/issues/17061

$ cdk acknowledge 16603
```

# `cdk bootstrap`
<a name="ref-cli-cmd-bootstrap"></a>

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

La pile bootstrap est une CloudFormation pile qui approvisionne un compartiment Amazon S3 et un référentiel Amazon ECR dans l' AWS environnement. La CLI AWS CDK utilise ces ressources pour stocker des modèles synthétisés et des ressources associées lors du déploiement.

## Utilisation
<a name="ref-cli-cmd-bootstrap-usage"></a>

```
$ cdk bootstrap <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-bootstrap-args"></a><a name="ref-cli-cmd-bootstrap-args-env"></a>

 ** AWS environnement**   
L' AWS environnement cible dans lequel déployer la pile bootstrap au format suivant : `aws://<account-id>/<region>`  
Exemple : `aws://123456789012/us-east-1`   
Cet argument peut être fourni plusieurs fois dans une seule commande pour déployer la pile bootstrap dans plusieurs environnements.  
Par défaut, la CLI CDK amorcera tous les environnements référencés dans l'application CDK ou déterminera un environnement à partir des sources par défaut. Il peut s'agir d'un environnement spécifié à l'aide de l'`--profile`option, à partir de variables d'environnement ou de sources AWS CLI par défaut.

## Options
<a name="ref-cli-cmd-bootstrap-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-bootstrap-options-bootstrap-bucket-name"></a>

 `--bootstrap-bucket-name, --toolkit-bucket-name, -b <STRING>`   
Nom du compartiment Amazon S3 qui sera utilisé par la CLI CDK. Ce bucket va être créé et ne doit pas exister actuellement.  
Fournissez cette option pour remplacer le nom par défaut du compartiment Amazon S3.  
Lorsque vous utilisez cette option, vous devrez peut-être personnaliser la synthèse. Pour en savoir plus, consultez [Personnaliser la synthèse de la pile CDK](configure-synth.md#bootstrapping-custom-synth).  
 *Valeur par défaut* : Non défini<a name="ref-cli-cmd-bootstrap-options-bootstrap-customer-key"></a>

 `--bootstrap-customer-key <BOOLEAN>`   
Créez une clé principale client (CMK) pour le bucket bootstrap (vous serez facturé mais vous pouvez personnaliser les autorisations, uniquement pour le bootstrap moderne).  
Cette option n'est pas compatible avec `--bootstrap-kms-key-id`.  
 *Valeur par défaut* : Non défini<a name="ref-cli-cmd-bootstrap-options-bootstrap-kms-key-id"></a>

 `--bootstrap-kms-key-id <STRING>`   
L'ID de clé principale AWS KMS à utiliser pour le `SSE-KMS` chiffrement.  
Fournissez cette option pour remplacer la clé AWS KMS par défaut utilisée pour chiffrer le compartiment Amazon S3.  
Cette option n'est pas compatible avec `--bootstrap-customer-key`.  
 *Valeur par défaut* : Non défini<a name="ref-cli-cmd-bootstrap-options-cloudformation-execution-policies"></a>

 `--cloudformation-execution-policies <ARRAY>`   
La politique IAM gérée ARNs qui doit être attachée au rôle de déploiement assumé AWS CloudFormation lors du déploiement de vos piles.  
Par défaut, les piles sont déployées avec des autorisations d'administrateur complètes à l'aide de cette `AdministratorAccess` politique.  
Vous pouvez fournir cette option plusieurs fois dans une seule commande. Vous pouvez également fournir plusieurs ARNs sous forme de chaîne unique, les individus étant ARNs séparés par des virgules. Voici un exemple :  

```
$ cdk bootstrap --cloudformation-execution-policies "arn:aws:iam::aws:policy/AWSLambda_FullAccess,arn:aws:iam::aws:policy/AWSCodeDeployFullAccess"
```
Pour éviter les échecs de déploiement, assurez-vous que les politiques que vous spécifiez sont suffisantes pour tous les déploiements que vous allez effectuer dans l'environnement en cours de démarrage.  
Cette option s'applique uniquement au bootstrap moderne.  
Le modèle bootstrap moderne accorde efficacement les autorisations implicites `--cloudformation-execution-policies` à n'importe quel AWS compte de la `--trust` liste. Par défaut, cela étend les autorisations de lecture et d'écriture à n'importe quelle ressource du compte bootstrap. Assurez-vous de [configurer la pile d'amorçage](bootstrapping-customizing.md) avec des politiques et des comptes fiables avec lesquels vous êtes à l'aise.
 *Valeur par défaut* : `[]` <a name="ref-cli-cmd-bootstrap-options-custom-permissions-boundary"></a>

 `--custom-permissions-boundary, -cpb <STRING>`   
Spécifiez le nom d'une limite d'autorisation à utiliser.  
Cette option n'est pas compatible avec `--example-permissions-boundary`.  
 *Valeur par défaut* : Non défini<a name="ref-cli-cmd-bootstrap-options-example-permissions-boundary"></a>

 `--example-permissions-boundary, -epb <BOOLEAN>`   
Utilisez l'exemple de limite d'autorisations fourni par le AWS CDK.  
Cette option n'est pas compatible avec `--custom-permissions-boundary`.  
La politique de limite des autorisations fournie par le CDK doit être considérée comme un exemple. Modifiez le contenu et faites référence à l'exemple de politique si vous testez la fonctionnalité. Convertissez-la en une nouvelle politique pour les déploiements réels, s'il n'en existe pas déjà une. Le souci est d'éviter la dérive. Très probablement, une limite d'autorisations est maintenue et comporte des conventions spécifiques, y compris la dénomination.  
Pour plus d'informations sur la configuration des autorisations, notamment sur l'utilisation des limites d'autorisations, consultez le [Guide de développement de la sécurité et](https://github.com/aws/aws-cdk/wiki/Security-And-Safety-Dev-Guide) de la sûreté.  
 *Valeur par défaut* : Non défini<a name="ref-cli-cmd-bootstrap-options-execute"></a>

 `--execute <BOOLEAN>`   
Configurez s'il faut exécuter l'ensemble de modifications.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-bootstrap-options-force"></a>

 `--force, -f <BOOLEAN>`   
Démarrez toujours, même si cela rétrograde la version du modèle de bootstrap.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-bootstrap-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk bootstrap` commande.<a name="ref-cli-cmd-bootstrap-options-previous-parameters"></a>

 `--previous-parameters <BOOLEAN>`   
Utilisez les valeurs précédentes pour les paramètres existants.  
Une fois qu'un modèle de bootstrap est déployé avec un ensemble de paramètres, vous devez définir cette option `false` pour modifier les paramètres lors de futurs déploiements. Quand`false`, vous devez réapprovisionner tous les paramètres précédemment fournis.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-bootstrap-options-public-access-block-configuration"></a>

 `--public-access-block-configuration <BOOLEAN>`   
Bloquez la configuration de l'accès public sur le compartiment Amazon S3 créé et utilisé par la CLI CDK.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-bootstrap-options-qualifier"></a>

 `--qualifier <STRING>`   
Valeur de chaîne à neuf chiffres unique pour chaque pile bootstrap. Cette valeur est ajoutée à l'identifiant physique des ressources de la pile bootstrap.  
En fournissant un qualificatif, vous évitez les conflits de noms de ressources lors du provisionnement de plusieurs piles de bootstrap dans le même environnement.  
Lorsque vous modifiez le qualificatif, votre application CDK doit transmettre la valeur modifiée au synthétiseur de pile. Pour plus d'informations, consultez [Personnaliser la synthèse de la pile CDK](configure-synth.md#bootstrapping-custom-synth).  
 *Valeur par défaut* : `hnb659fds`. Cette valeur n'a aucune signification.<a name="ref-cli-cmd-bootstrap-options-show-template"></a>

 `--show-template <BOOLEAN>`   
Au lieu d'amorcer, imprimez le modèle de bootstrap actuel sur la sortie standard (). `stdout` Vous pouvez ensuite copier et personnaliser le modèle selon vos besoins.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-bootstrap-options-tags"></a>

 `--tags, -t <ARRAY>`   
Tags à ajouter à la pile bootstrap au format de`KEY=VALUE`.  
 *Valeur par défaut* : `[]` <a name="ref-cli-cmd-bootstrap-options-template"></a>

 `--template <STRING>`   
Utilisez le modèle du fichier donné au lieu du modèle intégré.<a name="ref-cli-cmd-bootstrap-options-termination-protection"></a>

 `--termination-protection <BOOLEAN>`   
Activez AWS CloudFormation la protection de terminaison sur la pile bootstrap.  
Quand`true`, la protection contre les résiliations est activée. Cela empêche la suppression accidentelle de la pile bootstrap.  
Pour en savoir plus sur la protection contre le licenciement, consultez [la section Protection d'une pile contre la suppression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) dans le *Guide de AWS CloudFormation l'utilisateur*.  
 *Valeur par défaut* : Non défini<a name="ref-cli-cmd-bootstrap-options-toolkit-stack-name"></a>

 `--toolkit-stack-name <STRING>`   
Nom de la pile bootstrap à créer.  
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.  
La CLI CDK utilise cette valeur pour vérifier la version de votre stack bootstrap.  
 *Valeur par défaut* : `CDKToolkit`   
 *Obligatoire* : oui<a name="ref-cli-cmd-bootstrap-options-trust"></a>

 `--trust <ARRAY>`   
Le AWS compte IDs qui doit être fiable pour effectuer des déploiements dans cet environnement.  
Le compte effectuant le bootstrap sera toujours fiable.  
Cette option nécessite que vous fournissiez également`--cloudformation-execution-policies`.  
Vous pouvez fournir cette option plusieurs fois dans une seule commande.  
Cette option s'applique uniquement au bootstrap moderne.  
Pour ajouter des comptes fiables à une pile bootstrap existante, vous devez spécifier tous les comptes auxquels faire confiance, y compris ceux que vous avez fournis précédemment. Si vous ne fournissez que de nouveaux comptes auxquels faire confiance, les comptes précédemment approuvés seront supprimés.  
Voici un exemple qui fait confiance à deux comptes :  

```
$ cdk bootstrap aws://123456789012/us-west-2 --trust 234567890123 --trust 987654321098 --cloudformation-execution-policies arn:aws:iam::aws:policy/AdministratorAccess
 ⏳  Bootstrapping environment aws://123456789012/us-west-2...
Trusted accounts for deployment: 234567890123, 987654321098
Trusted accounts for lookup: (none)
Execution policies: arn:aws:iam::aws:policy/AdministratorAccess
CDKToolkit: creating CloudFormation changeset...
 ✅  Environment aws://123456789012/us-west-2 bootstrapped.
```
Le modèle bootstrap moderne accorde efficacement les autorisations implicites `--cloudformation-execution-policies` à n'importe quel AWS compte de la `--trust` liste. Par défaut, cela étend les autorisations de lecture et d'écriture à n'importe quelle ressource du compte bootstrap. Assurez-vous de [configurer la pile d'amorçage](bootstrapping-customizing.md) avec des politiques et des comptes fiables avec lesquels vous êtes à l'aise.
 *Valeur par défaut* : `[]` <a name="ref-cli-cmd-bootstrap-options-trust-for-lookup"></a>

 `--trust-for-lookup <ARRAY>`   
Le AWS compte IDs auquel il faut faire confiance pour rechercher des valeurs dans cet environnement.  
Utilisez cette option pour autoriser les comptes à synthétiser les piles qui seront déployées dans l'environnement, sans pour autant leur donner l'autorisation de déployer ces piles directement.  
Vous pouvez fournir cette option plusieurs fois dans une seule commande.  
Cette option s'applique uniquement au bootstrap moderne.  
 *Valeur par défaut* : `[]` 

## Exemples
<a name="ref-cli-cmd-bootstrap-examples"></a>

### Démarrez l' AWS environnement spécifié dans le profil de production
<a name="ref-cli-cmd-bootstrap-examples-1"></a>

```
$ cdk bootstrap --profile prod
```

### Déployez la pile bootstrap dans les environnements foo et bar
<a name="ref-cli-cmd-bootstrap-examples-2"></a>

```
$ cdk bootstrap --app='node bin/main.js' foo bar
```

### Exportez le modèle bootstrap pour le personnaliser
<a name="ref-cli-cmd-bootstrap-examples-3"></a>

Si vous avez des exigences spécifiques qui ne sont pas satisfaites par le modèle bootstrap, vous pouvez le personnaliser en fonction de vos besoins.

Vous pouvez exporter le modèle bootstrap, le modifier et le déployer à l'aide AWS CloudFormation de. Voici un exemple d'exportation du modèle existant :

```
$ cdk bootstrap --show-template > bootstrap-template.yaml
```

Vous pouvez également indiquer à la CLI CDK d'utiliser un modèle personnalisé. Voici un exemple :

```
$ cdk bootstrap --template my-bootstrap-template.yaml
```

### Bootstrap avec une limite d'autorisations. Supprimez ensuite cette limite d'autorisations
<a name="ref-cli-cmd-bootstrap-examples-4"></a>

Pour démarrer avec une limite d'autorisation personnalisée, nous exécutons ce qui suit :

```
$ cdk bootstrap --custom-permissions-boundary my-permissions-boundary
```

Pour supprimer la limite des autorisations, nous exécutons ce qui suit :

```
$ cdk bootstrap --no-previous-parameters
```

### Utilisez un qualificatif pour distinguer les ressources créées pour un environnement de développement
<a name="ref-cli-cmd-bootstrap-examples-5"></a>

```
$ cdk bootstrap --qualifier dev2024
```

# `cdk context`
<a name="ref-cli-cmd-context"></a>

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

 Le *contexte* représente les informations de configuration et d'environnement qui peuvent influencer la manière dont vos piles sont synthétisées et déployées. Utilisez `cdk context` pour effectuer les tâches suivantes :
+ Affichez les valeurs de contexte que vous avez configurées.
+ Définissez et gérez les valeurs de contexte.
+ Supprimez les valeurs de contexte.

## Utilisation
<a name="ref-cli-cmd-context-usage"></a>

```
$ cdk context <options>
```

## Options
<a name="ref-cli-cmd-context-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-context-options-clear"></a>

 `--clear <BOOLEAN>`   
Effacez tout le contexte.<a name="ref-cli-cmd-context-options-force"></a>

 `--force, -f <BOOLEAN>`   
Ignorez l'erreur de clé manquante.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-context-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk context` commande.<a name="ref-cli-cmd-context-options-reset"></a>

 `--reset, -e <STRING>`   
La clé de contexte, ou son index, à réinitialiser.

# `cdk deploy`
<a name="ref-cli-cmd-deploy"></a>

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

Pendant le déploiement, la CLI CDK produira des indicateurs de progression, similaires à ceux qui peuvent être observés depuis la AWS CloudFormation console.

Si l' AWS environnement n'est pas amorcé, seules les piles sans actifs et avec des modèles synthétisés de moins de 51 200 octets seront déployées avec succès.

## Utilisation
<a name="ref-cli-cmd-deploy-usage"></a>

```
$ cdk deploy <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-deploy-args"></a><a name="ref-cli-cmd-deploy-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK de votre application à déployer.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-deploy-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-deploy-options-all"></a>

 `--all <BOOLEAN>`   
Déployez toutes les piles dans votre application CDK.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-deploy-options-asset-parallelism"></a>

 `--asset-parallelism <BOOLEAN>`   
Spécifiez s'il faut créer et publier des actifs en parallèle.<a name="ref-cli-cmd-deploy-options-asset-prebuild"></a>

 `--asset-prebuild <BOOLEAN>`   
Spécifiez s'il faut créer tous les actifs avant de déployer la première pile. Cette option est utile en cas d'échec des builds de Docker.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-deploy-options-build-exclude"></a>

 `--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* : `[]` <a name="ref-cli-cmd-deploy-options-change-set-name"></a>

 `--change-set-name <STRING>`   
Nom du jeu de AWS CloudFormation modifications à créer.  
Cette option n'est pas compatible avec `--method='direct'`.<a name="ref-cli-cmd-deploy-options-concurrency"></a>

 `--concurrency <NUMBER>`   
Déployez 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 AWS CloudFormation de toute autre limite de taux du AWS compte.  
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` <a name="ref-cli-cmd-deploy-options-exclusively"></a>

 `--exclusively, -e <BOOLEAN>`   
Déployez uniquement les piles demandées et n'incluez pas les dépendances.<a name="ref-cli-cmd-deploy-options-force"></a>

 `--force, -f <BOOLEAN>`   
Lorsque vous déployez pour mettre à jour une pile existante, la CLI CDK compare le modèle et les balises de la pile déployée à la pile sur le point d'être déployée. Si aucune modification n'est détectée, la CLI CDK ignorera le déploiement.  
Pour contourner ce comportement et toujours déployer des piles, même si aucune modification n'est détectée, utilisez cette option.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-deploy-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk deploy` commande.<a name="ref-cli-cmd-deploy-options-hotswap"></a>

 `--hotswap <BOOLEAN>`   
Déploiements Hotswap pour un développement plus rapide. Cette option tente d'effectuer un déploiement à chaud plus rapide si possible. Par exemple, si vous modifiez le code d'une fonction Lambda dans votre application CDK, la CLI CDK mettra à jour la ressource directement via le service APIs au lieu d'effectuer un déploiement. CloudFormation   
Si la CLI CDK détecte des modifications qui ne prennent pas en charge le hotswapping, ces modifications seront ignorées et un message s'affichera. Si vous préférez effectuer un CloudFormation déploiement complet comme solution de rechange, utilisez `--hotswap-fallback` plutôt.  
La CLI CDK utilise vos AWS informations d'identification actuelles pour effectuer les appels d'API. Il n'assume pas les rôles de votre stack bootstrap, même si l'indicateur de `@aws-cdk/core:newStyleStackSynthesis` fonctionnalité est défini sur. `true` Ces rôles ne disposent pas des autorisations nécessaires pour mettre à jour les AWS ressources directement, sans les utiliser CloudFormation. Pour cette raison, assurez-vous que vos informations d'identification correspondent au même AWS compte que celui des piles sur lesquelles vous effectuez des déploiements hotswap et qu'elles disposent des autorisations IAM nécessaires pour mettre à jour les ressources.  
Le hotswapping est actuellement pris en charge pour les modifications suivantes :  
+ Ressources de code (y compris les images Docker et le code en ligne), modifications de balises et modifications de configuration (seules les variables de description et d'environnement sont prises en charge) des fonctions Lambda.
+ Versions Lambda et modifications d'alias.
+ Changements de définition des machines d'état AWS Step Functions.
+ Modifications des actifs des conteneurs des services Amazon ECS.
+ Modifications apportées aux actifs du site Web lors des déploiements de compartiments Amazon S3.
+ Changements liés à la source et à l'environnement AWS CodeBuild des projets.
+ Modifications du modèle de mappage VTL pour les AWS AppSync résolveurs et les fonctions.
+ Modifications du schéma pour AWS AppSync GraphQL APIs.
L'utilisation de certaines fonctions CloudFormation intrinsèques est prise en charge dans le cadre d'un déploiement par échange à chaud. Il s’agit des licences suivantes :  
+  `Ref` 
+  `Fn::GetAtt`— Pris en charge uniquement partiellement. Reportez-vous à [cette implémentation](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk/lib/api/evaluate-cloudformation-template.ts#L477-L492) pour connaître les ressources et les attributs pris en charge.
+  `Fn::ImportValue` 
+  `Fn::Join` 
+  `Fn::Select` 
+  `Fn::Split` 
+  `Fn::Sub` 
Cette option est également compatible avec les piles imbriquées.  
+ Cette option introduit délibérément une dérive dans les CloudFormation piles afin d'accélérer les déploiements. Pour cette raison, ne l'utilisez qu'à des fins de développement. N'utilisez pas cette option pour vos déploiements de production.
+ Cette option est considérée comme expérimentale et pourrait présenter des modifications majeures à l'avenir.
+ Les valeurs par défaut de certains paramètres peuvent être différentes selon le paramètre hotswap. Par exemple, le pourcentage de santé minimum d'un service Amazon ECS sera actuellement fixé à`0`. Vérifiez la source en conséquence si cela se produit.
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-deploy-options-hotswap-fallback"></a>

 `--hotswap-fallback <BOOLEAN>`   
Cette option est similaire à`--hotswap`. La différence étant que `--hotswap-fallback` cela revient à effectuer un CloudFormation déploiement complet si une modification le nécessitant est détectée.  
Pour plus d’informations sur cette option, consultez `--hotswap`.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-deploy-options-ignore-no-stacks"></a>

 `--ignore-no-stacks <BOOLEAN>`   
Effectuez un déploiement même si votre application CDK ne contient aucune pile.  
Cette option est utile dans le scénario suivant : vous pouvez avoir une application avec plusieurs environnements, tels que `dev` et`prod`. Lorsque vous démarrez le développement, il se peut que votre application de production ne dispose d'aucune ressource ou que les ressources soient commentées. Cela provoquera une erreur de déploiement avec un message indiquant que l'application n'a pas de piles. `--ignore-no-stacks`À utiliser pour contourner cette erreur.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-deploy-options-import-existing-resources"></a>

 `--import-existing-resources <BOOLEAN>`   
Importez des AWS CloudFormation ressources existantes non gérées depuis votre AWS compte.  
Lorsque vous utilisez cette option, les ressources de votre AWS CloudFormation modèle synthétisé portant le même nom personnalisé que les ressources non gérées existantes dans le même compte seront importées dans votre pile.  
Vous pouvez utiliser cette option pour importer des ressources existantes dans des piles nouvelles ou existantes.  
Vous pouvez importer des ressources existantes et déployer de nouvelles ressources dans la même `cdk deploy` commande.  
Pour en savoir plus sur les noms personnalisés, consultez la section [Type de nom](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) dans le *guide de AWS CloudFormation l'utilisateur*.  
Pour en savoir plus sur le `ImportExistingResources` CloudFormation paramètre, voir [AWS CloudFormation Simplifier l'importation des ressources avec un nouveau paramètre pour ChangeSets](https://aws.amazon.com/about-aws/whats-new/2023/11/aws-cloudformation-import-parameter-changesets/).  
Pour plus d'informations sur l'utilisation de cette option, voir [Importer des ressources existantes](https://github.com/aws/aws-cdk-cli/tree/main/packages/aws-cdk#import-existing-resources) dans le *aws-cdk-cli GitHub référentiel*.<a name="ref-cli-cmd-deploy-options-logs"></a>

 `--logs <BOOLEAN>`   
Afficher le CloudWatch journal Amazon dans la sortie standard (`stdout`) pour tous les événements provenant de toutes les ressources des piles sélectionnées.  
Cette option est uniquement compatible avec`--watch`.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-deploy-options-method"></a>

 `--method, -m <STRING>`   
Configurez la méthode pour effectuer un déploiement.  
+  `change-set`— Méthode par défaut. La CLI CDK crée un ensemble de CloudFormation modifications avec les modifications qui seront déployées, puis effectue le déploiement.
+  `direct`— Ne créez pas d'ensemble de modifications. Appliquez plutôt la modification immédiatement. Cela est généralement plus rapide que la création d'un ensemble de modifications, mais vous perdez les détails de la progression du déploiement dans la sortie de la CLI.
+  `prepare-change-set`— Créez un ensemble de modifications mais n'effectuez pas de déploiement. Cela est utile si vous disposez d'outils externes qui inspectent l'ensemble de modifications ou si vous disposez d'un processus d'approbation pour les ensembles de modifications.
 *Valeurs valides* : `change-set`, `direct`, `prepare-change-set`   
 *Valeur par défaut* : `change-set` <a name="ref-cli-cmd-deploy-options-notification-arns"></a>

 `--notification-arns <ARRAY>`   
Les ARNs rubriques Amazon SNS qui CloudFormation signaleront les événements liés au stack.<a name="ref-cli-cmd-deploy-options-outputs-file"></a>

 `--outputs-file, -O <STRING>`   
Le chemin vers lequel sont écrites les sorties de la pile des déploiements.  
Après le déploiement, les sorties de la pile seront écrites dans le fichier de sortie spécifié au format JSON.  
Vous pouvez configurer cette option dans le `cdk.json` fichier du projet ou `~/.cdk.json` sur votre machine de développement locale :  

```
{
   "app": "npx ts-node bin/myproject.ts",
   // ...
   "outputsFile": "outputs.json"
}
```
Si plusieurs piles sont déployées, les sorties sont écrites dans le même fichier de sortie, organisé par des clés représentant le nom de la pile.<a name="ref-cli-cmd-deploy-options-parameters"></a>

 `--parameters <ARRAY>`   
Transmettez des paramètres supplémentaires au CloudFormation cours du déploiement.  
Cette option accepte un tableau au format suivant :`STACK:KEY=VALUE`.  
+  `STACK`— Le nom de la pile à laquelle associer le paramètre.
+  `KEY`— Le nom du paramètre de votre pile.
+  `VALUE`— La valeur à transmettre lors du déploiement.
Si aucun nom de pile n'est fourni, ou s'il `*` est fourni comme nom de pile, les paramètres seront appliqués à toutes les piles déployées. Si une pile n'utilise pas le paramètre, le déploiement échouera.  
Les paramètres ne se propagent pas aux piles imbriquées. Pour transmettre des paramètres aux piles imbriquées, utilisez la ` [NestedStack](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.NestedStack.html) ` construction.  
 *Valeur par défaut* : `{}` <a name="ref-cli-cmd-deploy-options-previous-parameters"></a>

 `--previous-parameters <BOOLEAN>`   
Utilisez les valeurs précédentes pour les paramètres existants.  
Lorsque cette option est définie sur`false`, vous devez spécifier tous les paramètres pour chaque déploiement.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-deploy-options-progress"></a>

 `--progress <STRING>`   
Configurez la manière dont la CLI CDK 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` <a name="ref-cli-cmd-deploy-options-require-approval"></a>

 `--require-approval <STRING>`   
Spécifiez les modifications sensibles à la sécurité qui nécessitent une approbation manuelle.  
+  `any-change`— Approbation manuelle requise pour toute modification de la pile.
+  `broadening`— Une approbation manuelle est requise si les modifications impliquent un élargissement des autorisations ou des règles du groupe de sécurité.
+  `never`— Aucune approbation n'est requise.
 *Valeurs valides* : `any-change`, `broadening`, `never`   
 *Valeur par défaut* : `broadening` <a name="ref-cli-cmd-deploy-options-rollback"></a>

 `--rollback` \$1 `--no-rollback`, `-R`   
Pendant le déploiement, si une ressource ne parvient pas à être créée ou mise à jour, le déploiement reviendra à son dernier état stable avant le retour de la CLI CDK. 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.  
Spécifiez `--no-rollback` pour désactiver ce comportement. Si une ressource ne parvient pas à être créée ou mise à jour, la CLI CDK laissera les modifications apportées jusqu'à ce point en place et reviendra. Cela laissera votre déploiement dans un état d'échec et de pause. À partir de là, vous pouvez mettre à jour votre code et réessayer le déploiement. Cela peut être utile dans les environnements de développement dans lesquels vous effectuez des itérations rapides.  
Si un déploiement effectué avec `--no-rollback` échoue et que vous décidez d'annuler le déploiement, vous pouvez utiliser la `cdk rollback` commande. Pour plus d'informations, voir [cdk rollback](ref-cli-cmd-rollback.md).  
Avec`--no-rollback`, les déploiements qui entraînent le remplacement des ressources échoueront toujours. Vous ne pouvez utiliser cette valeur d'option que pour les déploiements qui mettent à jour ou créent de nouvelles ressources.
 *Valeur par défaut* : `--rollback` <a name="ref-cli-cmd-deploy-options-toolkit-stack-name"></a>

 `--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.  
La CLI CDK utilise cette valeur pour vérifier la version de votre stack bootstrap.<a name="ref-cli-cmd-deploy-options-watch"></a>

 `--watch <BOOLEAN>`   
Observez en permanence les fichiers de projet CDK et déployez automatiquement les piles spécifiées lorsque des modifications sont détectées.  
Cette option implique `--hotswap` par défaut.  
Cette option possède une commande CDK CLI équivalente. Pour plus d'informations, consultez [CDK Watch](ref-cli-cmd-watch.md).

## Exemples
<a name="ref-cli-cmd-deploy-examples"></a>

### Déployez la pile nommée MyStackName
<a name="ref-cli-cmd-deploy-examples-1"></a>

```
$ cdk deploy MyStackName --app='node bin/main.js'
```

### Déployer plusieurs piles dans une application
<a name="ref-cli-cmd-deploy-examples-2"></a>

`cdk list`À utiliser pour répertorier vos piles :

```
$ cdk list
CdkHelloWorldStack
CdkStack2
CdkStack3
```

Pour déployer toutes les piles, utilisez l'`--all`option suivante :

```
$ cdk deploy --all
```

Pour choisir les piles à déployer, fournissez les noms des piles en tant qu'arguments :

```
$ cdk deploy CdkHelloWorldStack CdkStack3
```

### Déployez des piles de pipelines
<a name="ref-cli-cmd-deploy-examples-3"></a>

`cdk list`À utiliser pour afficher les noms des piles sous forme de chemins, en indiquant leur position dans la hiérarchie du pipeline :

```
$ cdk list
PipelineStack
PiplelineStack/Prod
PipelineStack/Prod/MyService
```

Utilisez l'`--all`option ou le joker `*` pour déployer toutes les piles. Si vous avez une hiérarchie de piles telle que décrite ci-dessus, `--all` elle ne `*` correspondra qu'aux piles du niveau supérieur. Pour faire correspondre toutes les piles de la hiérarchie, utilisez`**`.

Vous pouvez combiner ces modèles. Ce qui suit déploie toutes les piles de la `Prod` phase :

```
$ cdk deploy PipelineStack/Prod/**
```

### Transmettre les paramètres lors du déploiement
<a name="ref-cli-cmd-deploy-examples-4"></a>

Définissez les paramètres de votre pile CDK. Voici un exemple qui crée un paramètre nommé `TopicNameParam` d'après une rubrique Amazon SNS :

```
new sns.Topic(this, 'TopicParameter', {
    topicName: new cdk.CfnParameter(this, 'TopicNameParam').value.toString()
});
```

Pour fournir une valeur de paramètre de`parameterized`, exécutez ce qui suit :

```
$ cdk deploy --parameters "MyStackName:TopicNameParam=parameterized"
```

Vous pouvez remplacer les valeurs des paramètres à l'aide de l'`--force`option. Voici un exemple de remplacement du nom de rubrique d'un déploiement précédent :

```
$ cdk deploy --parameters "MyStackName:TopicNameParam=parameterName" --force
```

### Écrire les sorties de la pile dans un fichier après le déploiement
<a name="ref-cli-cmd-deploy-examples-5"></a>

Définissez les sorties dans votre fichier de pile CDK. Voici un exemple de création d'une sortie pour une fonction ARN :

```
const fn = new lambda.Function(this, "fn", {
  handler: "index.handler",
  code: lambda.Code.fromInline(`exports.handler = \${handler.toString()}`),
  runtime: lambda.Runtime.NODEJS_LATEST
});

new cdk.CfnOutput(this, 'FunctionArn', {
  value: fn.functionArn,
});
```

Déployez la pile et écrivez les sorties pour `outputs.json` :

```
$ cdk deploy --outputs-file outputs.json
```

Voici un exemple d'`outputs.json`après-déploiement :

```
{
  "MyStack": {
    "FunctionArn": "arn:aws:lambda:us-east-1:123456789012:function:MyStack-fn5FF616E3-G632ITHSP5HK"
  }
}
```

Dans cet exemple, la clé `FunctionArn` correspond à l'ID logique de l'`CfnOutput`instance.

Voici un exemple de déploiement `outputs.json` après le déploiement de plusieurs piles :

```
{
  "MyStack": {
    "FunctionArn": "arn:aws:lambda:us-east-1:123456789012:function:MyStack-fn5FF616E3-G632ITHSP5HK"
  },
  "AnotherStack": {
    "VPCId": "vpc-z0mg270fee16693f"
  }
}
```

### Modifier la méthode de déploiement
<a name="ref-cli-cmd-deploy-examples-6"></a>

Pour un déploiement plus rapide, sans utiliser d'ensembles de modifications, utilisez `--method='direct'` :

```
$ cdk deploy --method='direct'
```

Pour créer un ensemble de modifications sans le déployer, utilisez`--method='prepare-change-set'`. Par défaut, un ensemble de modifications nommé `cdk-deploy-change-set` sera créé. Si un ensemble de modifications précédent portant ce nom existe, il sera remplacé. Si aucune modification n'est détectée, un ensemble de modifications vide est tout de même créé.

Vous pouvez également donner un nom à votre ensemble de modifications. Voici un exemple :

```
$ cdk deploy --method='prepare-change-set' --change-set-name='MyChangeSetName'
```

# `cdk destroy`
<a name="ref-cli-cmd-destroy"></a>

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

Lorsque vous supprimez une pile, les ressources qu'elle contient sont détruites, sauf si elles ont été configurées avec un `DeletionPolicy` de`Retain`.

Lors de la suppression de la pile, cette commande produira des informations de progression similaires au `cdk deploy` comportement.

## Utilisation
<a name="ref-cli-cmd-destroy-usage"></a>

```
$ cdk destroy <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-destroy-args"></a><a name="ref-cli-cmd-destroy-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK de votre application à supprimer.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-destroy-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-destroy-options-all"></a>

 `--all <BOOLEAN>`   
Détruisez toutes les piles disponibles.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-destroy-options-exclusively"></a>

 `--exclusively, -e <BOOLEAN>`   
Détruisez uniquement les piles demandées et n'incluez pas les dépendances.<a name="ref-cli-cmd-destroy-options-force"></a>

 `--force, -f <BOOLEAN>`   
Ne demandez pas de confirmation avant de détruire les piles.<a name="ref-cli-cmd-destroy-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk destroy` commande.

## Exemples
<a name="ref-cli-cmd-destroy-examples"></a>

### Supprimer une pile nommée MyStackName
<a name="ref-cli-cmd-destroy-examples-1"></a>

```
$ cdk destroy --app='node bin/main.js' <MyStackName>
```

# `cdk diff`
<a name="ref-cli-cmd-diff"></a>

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

Cette commande est généralement utilisée pour comparer les différences entre l'état actuel des piles dans votre application CDK locale et les piles déployées. Toutefois, vous pouvez également comparer une pile déployée avec n'importe quel AWS CloudFormation modèle local.

## Utilisation
<a name="ref-cli-cmd-diff-usage"></a>

```
$ cdk diff <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-diff-args"></a><a name="ref-cli-cmd-diff-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK de votre application pour effectuer une différence.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-diff-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-diff-options-change-set"></a>

 `--change-set <BOOLEAN>`   
Spécifiez s'il faut créer un ensemble de modifications pour analyser les remplacements de ressources.  
À `true` ce moment-là, la CLI CDK créera un ensemble de AWS CloudFormation modifications pour afficher les modifications exactes qui seront apportées à votre pile. Ce résultat indique si les ressources seront mises à jour ou remplacées. La CLI CDK utilise le rôle de déploiement au lieu du rôle de recherche pour effectuer cette action.  
Lorsque`false`, une différence plus rapide mais moins précise est effectuée en comparant des modèles. CloudFormation Toute modification détectée dans les propriétés nécessitant le remplacement de ressources sera affichée comme un remplacement de ressource, même si la modification est purement esthétique, comme le remplacement d'une référence de ressource par un ARN codé en dur.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-diff-options-context-lines"></a>

 `--context-lines <NUMBER>`   
Nombre de lignes de contexte à inclure dans un rendu différentiel JSON arbitraire.  
 *Valeur par défaut* : `3` <a name="ref-cli-cmd-diff-options-exclusively"></a>

 `--exclusively, -e <BOOLEAN>`   
Ne différentiez que les piles demandées et n'incluez pas les dépendances.<a name="ref-cli-cmd-diff-options-fail"></a>

 `--fail <BOOLEAN>`   
Échouez et quittez avec un code indiquant `1` si des différences sont détectées.<a name="ref-cli-cmd-diff-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk diff` commande.<a name="ref-cli-cmd-diff-options-processed"></a>

 `--processed <BOOLEAN>`   
Spécifiez s'il faut effectuer une comparaison avec le modèle avec les CloudFormation transformations déjà traitées.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-diff-options-quiet"></a>

 `--quiet, -q <BOOLEAN>`   
N'imprimez pas le nom de la pile CDK ni le `cdk diff` message par défaut `stdout` lorsqu'aucune modification n'est détectée.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-diff-options-security-only"></a>

 `--security-only <BOOLEAN>`   
Ne différentiez que pour les modifications de sécurité étendues.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-diff-options-strict"></a>

 `--strict <BOOLEAN>`   
Modifiez `cdk diff` le comportement pour qu'il soit plus précis ou plus strict. Lorsque c'est vrai, la CLI CDK ne filtre pas les ` AWS::CDK::Metadata` ressources ni les caractères non ASCII illisibles.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-diff-options-template"></a>

 `--template <STRING>`   
Le chemin d'accès au CloudFormation modèle avec lequel comparer une pile de CDK.

## Exemples
<a name="ref-cli-cmd-diff-examples"></a>

### Différence par rapport à la pile actuellement déployée nommée MyStackName
<a name="ref-cli-cmd-diff-examples-1"></a>

La CLI CDK utilise les symboles suivants dans la sortie diff :
+  `[+]`— Identifie le code ou les ressources qui seront ajoutés si vous déployez vos modifications.
+  `[-]`— Identifie le code ou les ressources qui seront supprimés si vous déployez vos modifications.
+  `[~]`— Identifie une ressource ou une propriété qui sera modifiée si vous déployez vos modifications.

L'exemple suivant montre une différence entre les modifications locales apportées à une fonction Lambda :

```
$ cdk diff MyStackName
start: Building <asset-hash>:<account:Region>
success: Built <asset-hash>:<account:Region>
start: Publishing <asset-hash>:<account:Region>
success: Published <asset-hash>:<account:Region>
Hold on while we create a read-only change set to get a diff with accurate replacement information (use --no-change-set to use a less accurate but faster template-only diff)
Stack MyStackName
Resources
[~] AWS::Lambda::Function HelloWorldFunction <resource-logical-ID>
 └─ [~] Code
     └─ [~] .ZipFile:
         ├─ [-]
        exports.handler = async function(event) {
          return {
            statusCode: 200,
            body: JSON.stringify('Hello World!'),
          };
        };

         └─ [+]
        exports.handler = async function(event) {
          return {
            statusCode: 200,
            body: JSON.stringify('Hello from CDK!'),
          };
        };



✨  Number of stacks with differences: 1
```

Un `[~]` indicateur des ressources qui seront modifiées ne signifie pas toujours un remplacement complet des ressources :
+ Certaines propriétés de ressource, telles que`Code`, mettent à jour la ressource.
+ Certaines propriétés des ressources, telles que`FunctionName`, peuvent entraîner le remplacement complet des ressources.

### Différencier par rapport à un modèle spécifique CloudFormation
<a name="ref-cli-cmd-diff-examples-2"></a>

```
$ cdk diff MyStackName --app='node bin/main.js' --template-path='./MyStackNameTemplate.yaml'
```

### Différenciez une pile locale avec sa pile déployée. N'imprimez pas sur stdout si aucune modification n'est détectée
<a name="ref-cli-cmd-diff-examples-3"></a>

```
$ cdk diff MyStackName --app='node bin/main.js' --quiet
```

# `cdk docs`
<a name="ref-cli-cmd-docs"></a>

Ouvrez la documentation du AWS CDK dans votre navigateur.

## Utilisation
<a name="ref-cli-cmd-docs-usage"></a>

```
$ cdk docs <options>
```

## Options
<a name="ref-cli-cmd-docs-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-docs-options-browser"></a>

 `--browser, -b <STRING>`   
Commande à utiliser pour ouvrir le navigateur, en utilisant `%u` comme espace réservé le chemin du fichier à ouvrir.  
 *Valeur par défaut* : `open %u` <a name="ref-cli-cmd-docs-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk docs` commande.

## Exemples
<a name="ref-cli-cmd-docs-examples"></a>

### Ouvrez la documentation du AWS CDK dans Google Chrome
<a name="ref-cli-cmd-docs-examples-1"></a>

```
$ cdk docs --browser='chrome %u'
```

# `cdk doctor`
<a name="ref-cli-cmd-doctor"></a>

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

Ces informations peuvent aider à résoudre les problèmes liés au CDK et doivent être fournies lors de la soumission de rapports de bogues.

## Utilisation
<a name="ref-cli-cmd-doctor-usage"></a>

```
$ cdk doctor <options>
```

## Options
<a name="ref-cli-cmd-doctor-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-doctor-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk doctor` commande.

## Exemples
<a name="ref-cli-cmd-doctor-examples"></a>

### Exemple simple de `cdk doctor` commande
<a name="ref-cli-cmd-doctor-examples-1"></a>

```
$ cdk doctor
ℹ️ CDK Version: 1.0.0 (build e64993a)
ℹ️ AWS environment variables:
  - AWS_EC2_METADATA_DISABLED = 1
  - AWS_SDK_LOAD_CONFIG = 1
```

# `cdk drift`
<a name="ref-cli-cmd-drift"></a>

Détectez les dérives de configuration pour les ressources que vous définissez, gérez et déployez à l'aide du AWS Cloud Development Kit (AWS CDK). La dérive se produit lorsque la configuration réelle d'une pile diffère de la configuration attendue, ce qui se produit lorsque les ressources sont modifiées en dehors de AWS CloudFormation.

Cette commande identifie les ressources qui ont été modifiées (par exemple, via la AWS console ou la AWS CLI) en comparant leur état actuel à leur configuration attendue. Ces modifications peuvent entraîner un comportement inattendu dans votre infrastructure.

Lors de la détection de la dérive, la CLI CDK produira des indicateurs de progression et des résultats, indiquant :
+ Ressources qui se sont éloignées de leur configuration attendue.
+ Le nombre total de ressources présentant une dérive.
+ Un résumé indiquant si une dérive a été détectée dans la pile.

**Important**  
Les `cdk diff` commandes `cdk drift` et fonctionnent différemment :  
 `cdk drift`appelle CloudFormation l'opération de détection de dérive pour comparer l'état réel des ressources dans AWS (« réalité ») à leur configuration attendue dans CloudFormation. Toutes les AWS ressources ne prennent pas en charge la détection de la dérive. Pour obtenir la liste des ressources prises en charge, consultez la section [Support des types de ressources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) dans le *guide de AWS CloudFormation l'utilisateur*.
 `cdk diff`compare le CloudFormation modèle synthétisé à partir de votre code CDK local avec le modèle de la pile déployée CloudFormation .
À utiliser `cdk drift` lorsque vous devez vérifier si les ressources ont été modifiées en dehors de CloudFormation (par exemple, via la AWS console ou la AWS CLI). À utiliser `cdk diff` lorsque vous souhaitez avoir un aperçu de l'impact de vos modifications de code local sur votre infrastructure avant le déploiement.

## Utilisation
<a name="ref-cli-cmd-drift-usage"></a>

```
$ cdk drift <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-drift-args"></a><a name="ref-cli-cmd-drift-args-stack-name"></a>

 **Nom de la pile**   
Nom de la pile dont vous souhaitez vérifier la dérive. La pile doit être préalablement déployée pour CloudFormation effectuer une détection de dérive.  
 *Type* : chaîne  
 *Obligatoire* : non  
Si aucune pile n'est spécifiée, la détection de dérive sera effectuée sur toutes les piles définies dans votre application CDK.

## Options
<a name="ref-cli-cmd-drift-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-drift-options-fail"></a>

 `--fail <BOOLEAN>`   
Retournez avec le code de sortie 1 si une dérive est détectée.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-drift-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk drift` commande.

## Exemples
<a name="ref-cli-cmd-drift-examples"></a>

### Vérifier la dérive pour une pile spécifique
<a name="ref-cli-cmd-drift-examples-stack"></a>

```
$ cdk drift MyStackName
```

La commande produira des résultats similaires à :

```
Stack MyStackName
Modified Resources
[~] AWS::Lambda::Function MyFunction MyLambdaFunc1234ABCD
 └─ [~] /Description
     ├─ [-] My original hello world Lambda function
     └─ [+] My drifted hello world Lambda function

1 resource has drifted from their expected configuration

✨  Number of resources with drift: 1
```

### Vérifiez la dérive lorsque des ressources ont été supprimées
<a name="ref-cli-cmd-drift-examples-deleted"></a>

L'exemple suivant montre à quoi ressemble le résultat lorsque les ressources ont été modifiées et supprimées :

```
Stack MyStackName
Modified Resources
[~] AWS::Lambda::Function MyFunction MyLambdaFunc1234ABCD
 └─ [~] /Description
     ├─ [-] My original hello world Lambda function
     └─ [+] My drifted hello world Lambda function
Deleted Resources
[-] AWS::CloudWatch::Alarm MyAlarm MyCWAlarmABCD1234

2 resources have drifted from their expected configuration

✨  Number of resources with drift: 2
```

### Vérifiez la dérive avec le code de sortie
<a name="ref-cli-cmd-drift-examples-fail"></a>

Pour que la commande renvoie un code de sortie différent de zéro si une dérive est détectée :

```
$ cdk drift MyStackName --fail
```

Cela est utile dans les pipelines CI/CD pour détecter et répondre automatiquement à la dérive de l'infrastructure.

# `cdk flags`
<a name="ref-cli-cmd-flags"></a>

Affichez et modifiez les configurations de vos indicateurs de fonctionnalité pour la CLI CDK.

Les indicateurs de fonctionnalité contrôlent le comportement de la CLI CDK et vous pouvez les utiliser pour activer ou désactiver des fonctionnalités spécifiques. Utilisez la `cdk flags` commande pour afficher les configurations actuelles de vos indicateurs de fonctionnalité et modifiez-les selon vos besoins.

**Avertissement**  
La `cdk flags` commande est en cours de développement pour le AWS CDK. Les fonctionnalités actuelles de cette commande sont considérées comme prêtes pour la production et peuvent être utilisées en toute sécurité. Cependant, la portée de cette commande et ses fonctionnalités sont susceptibles d'être modifiées. Par conséquent, vous devez vous inscrire en fournissant l'`unstable=flags`option d'utiliser cette commande.

## Utilisation
<a name="ref-cli-cmd-flags-usage"></a>

```
$ cdk flags <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-flags-args"></a><a name="ref-cli-cmd-flags-args-flagname"></a>

 **NOM DU DRAPEAU**   
Le nom de l'indicateur de fonctionnalité spécifique que vous souhaitez afficher ou modifier.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-flags-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-flags-options-set"></a>

 `--set <BOOLEAN>`   
Modifiez la configuration d'un indicateur de fonctionnalité.<a name="ref-cli-cmd-flags-options-all"></a>

 `--all <BOOLEAN>`   
Modifiez ou affichez tous les indicateurs de fonctionnalités.<a name="ref-cli-cmd-flags-options-recommended"></a>

 `--recommended <BOOLEAN>`   
Remplacez les drapeaux par les états recommandés.<a name="ref-cli-cmd-flags-options-default"></a>

 `--default <BOOLEAN>`   
Remplacez les drapeaux par défaut.<a name="ref-cli-cmd-flags-options-unconfigured"></a>

 `--unconfigured <BOOLEAN>`   
Modifiez les indicateurs de fonctionnalités non configurés.<a name="ref-cli-cmd-flags-options-value"></a>

 `--value <STRING>`   
La valeur à laquelle définir la configuration de l'indicateur de fonctionnalité.  
 *requireArg* : vrai<a name="ref-cli-cmd-flags-options-safe"></a>

 `--safe <BOOLEAN>`   
Activez tous les indicateurs de fonctionnalités qui n'ont aucun impact sur votre application.<a name="ref-cli-cmd-flags-options-interactive"></a>

 `--interactive, -i <BOOLEAN>`   
Option interactive pour la commande flags.

## Exemples
<a name="ref-cli-cmd-flags-examples"></a>

### Afficher les configurations des indicateurs de fonctionnalités
<a name="ref-cli-cmd-flags-examples-1"></a>

Exécutez `cdk flags` pour afficher un rapport sur les configurations de vos indicateurs de fonctionnalités qui diffèrent des états recommandés. Les drapeaux non configurés sont étiquetés avec une `<unset>` étiquette indiquant qu'ils n'ont actuellement aucune valeur. Les drapeaux sont affichés dans l'ordre suivant :
+ Drapeaux définis sur une valeur qui ne correspond pas à notre valeur recommandée
+ Drapeaux que vous n'avez pas configurés

```
$ cdk flags --unstable=flags
Feature Flag                           Recommended                       User
* @aws-cdk/...                              true                         false
* @aws-cdk/...                              true                         false
* @aws-cdk/...                              true                         <unset>
```

Vous pouvez également exécuter `cdk flags --all` pour voir un rapport de tous les indicateurs de fonctionnalités dans l'ordre suivant :
+ Drapeaux définis sur une valeur correspondant à notre valeur recommandée
+ Drapeaux définis sur une valeur qui ne correspond pas à notre valeur recommandée
+ Drapeaux que vous n'avez pas configurés

```
$ cdk flags --unstable=flags --all
Feature Flag                              Recommended                     User
@aws-cdk/...                                true                         true
* @aws-cdk/...                              true                         false
* @aws-cdk/...                              true                         false
* @aws-cdk/...                              true                         <unset>
```

### Modifier les valeurs des indicateurs de fonction
<a name="ref-cli-cmd-flags-examples-2"></a>

Pour modifier vos indicateurs de fonctionnalités de manière interactive, exécutez `cdk flags --interactive` (ou`cdk flags -i`) pour afficher une liste d'options de menu.

Pour remplacer chaque indicateur de fonctionnalité par notre valeur recommandée, exécutez`cdk flags --set --recommended --all`. Cette commande conserve la configuration de votre indicateur de fonctionnalité up-to-date avec les dernières configurations d'indicateur de fonctionnalité du CDK. Sachez que l'exécution de cette commande peut potentiellement remplacer les valeurs configurées existantes.

```
$ cdk flags --unstable=flags --set --recommended --all
Feature Flag                              Recommended Value            User Value
* @aws-cdk/...                              true                         false
* @aws-cdk/...                              true                         false
* @aws-cdk/...                              true                         <unset>
  Synthesizing...
    Resources
    [~] AWS::S3::Bucket MyBucket
    └─ [~] Properties
        └─ [~] Encryption
                ...
    Number of stacks with differences: 2
  Do you want to accept these changes? (y/n) y
  Resynthesizing...
```

Si vous souhaitez conserver l'état de vos drapeaux configurés existants, exécutez`cdk flags --set --recommended --unconfigured`. Cette option remplace uniquement les indicateurs de fonctionnalité non configurés par nos valeurs recommandées.

```
$ cdk flags --unstable=flags --set --recommended --unconfigured
Feature Flag                              Recommended Value            User Value
* @aws-cdk/...                              true                         <unset>
* @aws-cdk/...                              true                         <unset>
  Synthesizing...
    Resources
    [~] AWS::S3::Bucket MyBucket
    └─ [~] Properties
        └─ [~] Encryption
            ├─ [-] None
            └─ [+] ServerSideEncryptionConfiguration:
                    - ...
            ...
    Number of stacks with differences: 2
  Do you want to accept these changes? (y/n) y
  Resynthesizing...
```

Pour vous assurer qu'aucun indicateur de fonctionnalité non configuré n'interfère avec votre application, exécutez la `cdk flags --set --default --unconfigured` commande pour rétablir les valeurs par défaut des indicateurs non configurés. Par exemple, s'il `@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021` n'est pas configuré, une notification s'affiche après l'exécution`cdk synth`. Toutefois, si vous réglez l'indicateur sur son état par défaut (faux), il sera configuré, désactivé et n'aura aucun impact sur votre application.

```
$ cdk flags --unstable=flags --set --default --unconfigured
Feature Flag                              Recommended Value            User Value
* @aws-cdk/...                              true                         <unset>
* @aws-cdk/...                              true                         <unset>
  Synthesizing...

  Do you want to accept these changes? (y/n) y
  Resynthesizing...
```

### Inspectez les indicateurs de fonctionnalités spécifiques
<a name="ref-cli-cmd-flags-examples-3"></a>

#### Afficher plus d'informations sur un drapeau
<a name="_view_more_information_about_a_flag"></a>

En plus d'exécuter `cdk flags` et de `cdk flags --all` visualiser la configuration de votre indicateur de fonctionnalité, vous pouvez également l'utiliser `cdk flags "FLAGNAME"` pour inspecter un indicateur de fonctionnalité spécifique et découvrir à quoi sert cet indicateur. Cela peut être utile dans les cas où vous souhaitez comprendre un indicateur en particulier et son impact sur votre application.

```
$ cdk flags --unstable=flags "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021"
    Description: Enable this feature flag to have cloudfront distributions use the security policy TLSv1.2_2021 by default.
    Recommended Value: true
    User Value: true
```

#### Filtrer les drapeaux par sous-chaîne
<a name="_filter_flags_by_substring"></a>

Vous pouvez également courir `cdk flags substring` pour voir tous les indicateurs de fonctionnalités correspondants. Si un seul indicateur de fonctionnalité correspond à cette sous-chaîne, des détails spécifiques sont affichés.

```
$ cdk flags --unstable=flags ebs
@aws-cdk/aws-ec2:ebsDefaultGp3Volume
    Description: When enabled, the default volume type of the EBS volume will be GP3
    Recommended Value: true
    User Value: true
```

Si plusieurs indicateurs correspondent à la sous-chaîne, tous les indicateurs correspondants sont affichés dans un tableau. Si vous entrez plusieurs sous-chaînes, tous les indicateurs correspondants contenant l'une des sous-chaînes sont renvoyés.

```
$ cdk flags --unstable=flags s3 lambda
Feature Flag                              Recommended                     User
* @aws-cdk/s3...                            true                         false
* @aws-cdk/lambda...                        true                         false
* @aws-cdk/lambda...                        true                         <unset>
```

#### Modifier un drapeau spécifique
<a name="_modify_a_specific_flag"></a>

Si vous devez modifier la valeur d'un indicateur et vous assurer que vous le définissez sur un état correct et compatible, exécutez`cdk flags --set "FLAGNAME" --value="state"`.

```
$ cdk flags --unstable=flags --set "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021" --value="true"
  Synthesizing...
    Resources
    [~] AWS::CloudFront::Distribution MyDistribution
    └─ [~] Properties
        └─ [~] DefaultSecurityPolicy
            ├─ [-] TLSv1.0
            └─ [+] TLSv1.2_2021
                    - ...
    Number of stacks with differences: 2
  Do you want to accept these changes? (y/n) y
  Resynthesizing...
```

# `cdk gc`
<a name="ref-cli-cmd-gc"></a>

Utilisez la commande d'interface de ligne de commande (CLI) du AWS Cloud Development Kit (AWS CDK) `cdk gc` pour collecter les déchets sur les actifs inutilisés stockés dans les ressources de votre stack bootstrap. Utilisez cette commande pour afficher, gérer et supprimer les actifs dont vous n'avez plus besoin.

Pour les actifs Amazon Simple Storage Service (Amazon S3), la CLI CDK vérifie les modèles AWS CloudFormation existants dans le même environnement pour voir s'ils sont référencés. S'ils ne sont pas référencés, ils seront considérés comme non utilisés et éligibles aux actions de collecte des déchets.

**Avertissement**  
La `cdk gc` commande est en cours de développement pour le AWS CDK. Les fonctionnalités actuelles de cette commande sont considérées comme prêtes pour la production et peuvent être utilisées en toute sécurité. Cependant, la portée de cette commande et ses fonctionnalités sont susceptibles d'être modifiées. Par conséquent, vous devez vous inscrire en fournissant l'`unstable=gc`option d'utiliser cette commande.

## Utilisation
<a name="ref-cli-cmd-gc-usage"></a>

```
$ cdk gc <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-gc-args"></a><a name="ref-cli-cmd-gc-args-env"></a>

 ** AWS environnement**   
L' AWS environnement cible sur lequel effectuer les actions de collecte des déchets.  
Lorsque vous fournissez un environnement, utilisez le format suivant :`aws://<account-id>/<region>`. Par exemple, `aws://<123456789012>/<us-east-1>`.  
Cet argument peut être fourni plusieurs fois dans une seule commande pour effectuer des actions de collecte des déchets dans plusieurs environnements.  
Par défaut, la CLI CDK effectue des actions de collecte des déchets sur tous les environnements auxquels vous faites référence dans votre application CDK ou que vous fournissez en tant qu'arguments. Si vous ne fournissez pas d'environnement, la CLI CDK déterminera l'environnement à partir des sources par défaut. Ces sources incluent les environnements que vous spécifiez à l'aide de l'`--profile`option, les variables d'environnement ou les sources AWS CLI par défaut.

## Options
<a name="ref-cli-cmd-gc-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-gc-options-action"></a>

 `--action <STRING>`   
Action exécutée sur vos actifs lors d'un ramassage des ordures. `cdk gc`  
+  `delete-tagged`— Supprime les actifs marqués d'une date comprise dans la plage de jours tampon que vous fournissez, mais ne balise pas les actifs inutilisés récemment identifiés.
+  `full`— Effectuez toutes les actions de collecte des ordures. Cela inclut la suppression des actifs dans la plage de jours tampon que vous fournissez et le marquage des actifs inutilisés récemment identifiés.
+  `print`— Affiche le nombre de ressources inutilisées à l'invite de commande, mais n'apporte aucune modification réelle dans votre AWS environnement.
+  `tag`— Marque tous les actifs inutilisés récemment identifiés, mais ne supprime aucun actif dans la plage de jours tampon que vous fournissez.
 *Valeurs acceptées* : `delete-tagged``full`,`print`, `tag`   
 *Valeur par défaut* : `full` <a name="ref-cli-cmd-gc-options-bootstrap-stack-name"></a>

 `--bootstrap-stack-name <STRING>`   
Le nom de la pile de bootstrap CDK dans votre AWS environnement. Fournissez cette option si vous avez personnalisé le nom de votre pile bootstrap. Si vous utilisez le nom de `CDKToolkit` pile par défaut, vous n'êtes pas obligé de fournir cette option.  
 *Valeur par défaut* : `CDKToolkit` <a name="ref-cli-cmd-gc-options-confirm"></a>

 `--confirm <BOOLEAN>`   
Spécifiez si la CLI CDK vous demandera une confirmation manuelle avant de supprimer des actifs.  
Spécifiez `false` pour supprimer automatiquement les actifs sans vous demander de confirmation manuelle.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-gc-options-created-buffer-days"></a>

 `--created-buffer-days <NUMBER>`   
Le nombre de jours pendant lesquels un actif doit exister avant qu'il ne soit éligible aux actions de collecte des ordures.  
Lorsque vous fournissez un numéro, les actifs qui n'existent pas au-delà du nombre de jours que vous avez spécifié sont exclus des actions de collecte des déchets.  
 *Valeur par défaut* : `1` <a name="ref-cli-cmd-gc-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk gc` commande.<a name="ref-cli-cmd-gc-options-rollback-buffer-days"></a>

 `--rollback-buffer-days <NUMBER>`   
Le nombre de jours pendant lesquels un actif doit être étiqueté comme isolé avant qu'il ne soit éligible aux actions de collecte des ordures.  
Lorsque vous fournissez un numéro, la CLI CDK étiquette les actifs inutilisés avec la date actuelle au lieu de les supprimer. La CLI CDK vérifiera également si des actifs ont été balisés lors des précédentes exécutions de la `cdk gc` commande. Les actifs précédemment balisés qui se situent dans la plage de jours tampon que vous fournissez seront supprimés.  
 *Valeur par défaut* : `0` <a name="ref-cli-cmd-gc-options-type"></a>

 `--type <STRING>`   
Type de ressource bootstrap au sein de votre pile bootstrap sur laquelle effectuer des actions de collecte des déchets.  
+  `all`— Effectuez des actions de collecte des déchets sur toutes les ressources amorcées.
+  `ecr`— Effectuez des actions de collecte des déchets sur les actifs du référentiel Amazon Elastic Container Registry (Amazon ECR) de votre stack bootstrap.
+  `s3`— Effectuez des actions de collecte des déchets sur les actifs du compartiment Amazon S3 de votre stack bootstrap.
 *Valeurs acceptées* :`all`,`ecr`, `s3`   
 *Valeur par défaut* : `all` <a name="ref-cli-cmd-gc-options-unstable"></a>

 `--unstable <STRING>`   
Autorisez l'utilisation des commandes CDK CLI qui sont encore en cours de développement.  
Cette option est requise pour utiliser toute commande CDK CLI encore en développement et susceptible d'être modifiée.  
Cette option peut être fournie plusieurs fois en une seule commande.  
Pour utiliser`cdk gc`, fournissez`--unstable=gc`.

## Exemples
<a name="ref-cli-cmd-gc-examples"></a>

### Exemples de base
<a name="ref-cli-cmd-gc-examples-basic"></a>

L'exemple suivant vous demande de confirmer manuellement l'exécution des actions de collecte des déchets par défaut sur les actifs du compartiment Amazon S3 de votre stack bootstrap :

```
$ cdk gc --unstable=gc --type=s3

 ⏳  Garbage Collecting environment aws://<account-id>/<region>...
Found 99 assets to delete based off of the following criteria:
- assets have been isolated for > 0 days
- assets were created > 1 days ago

Delete this batch (yes/no/delete-all)?
```

L'exemple suivant exécute des actions de collecte des déchets sur une série d'actifs du compartiment Amazon S3 de votre stack bootstrap. Cette gamme inclut les actifs qui ont déjà été étiquetés par `cdk gc` pendant plus de 30 jours et qui ont été créés il y a 10 jours ou plus. Cette commande vous demandera une confirmation manuelle avant de supprimer des actifs :

```
$ cdk gc --unstable=gc --type=s3 --rollback-buffer-days=30 --created-buffer-days=10
```

L'exemple suivant exécute l'action de suppression des actifs précédemment balisés dans le compartiment Amazon S3 de votre stack bootstrap qui sont inutilisés depuis plus de 30 jours :

```
$ cdk gc --unstable=gc --type=s3 --action=delete-tagged --rollback-buffer-days=30
```

# `cdk import`
<a name="ref-cli-cmd-import"></a>

Utilisez [les importations de AWS CloudFormation ressources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html) 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énement. 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html) dans le *guide de AWS CloudFormation l'utilisateur*.

 **Pour importer une ressource existante dans une pile de CDK**   

1. Exécutez un `cdk diff` pour vous assurer qu'aucune modification n'est en attente sur votre pile de CDK. Lors de l'exécution d'une opération d'importation`cdk import`, les seules modifications autorisées sont l'ajout de nouvelles ressources en cours d'importation.

1. 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 les clés AWS KMS, les politiques de cycle de vie et tout autre élément 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.

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

1. La CLI CDK vous invite à transmettre les noms réels des ressources que vous importez. Une fois que vous aurez fourni ces informations, l'importation commencera.

1. 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
<a name="ref-cli-cmd-import-usage"></a>

```
$ cdk import <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-import-args"></a><a name="ref-cli-cmd-import-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK de votre application vers laquelle vous souhaitez importer des ressources. Cet argument peut être fourni plusieurs fois dans une seule commande.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-import-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-import-options-change-set-name"></a>

 `--change-set-name <STRING>`   
Nom du jeu de CloudFormation modifications à créer.<a name="ref-cli-cmd-import-options-execute"></a>

 `--execute <BOOLEAN>`   
Spécifiez s'il faut exécuter l'ensemble de modifications.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-import-options-force"></a>

 `--force, -f <BOOLEAN>`   
Par défaut, la CLI CDK 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.<a name="ref-cli-cmd-import-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk import` commande.<a name="ref-cli-cmd-import-options-record-resource-mapping"></a>

 `--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.<a name="ref-cli-cmd-import-options-resource-mapping"></a>

 `--resource-mapping, -m <STRING>`   
Utilisez cette option pour spécifier un fichier qui définit le mappage de vos ressources. La CLI CDK 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.<a name="ref-cli-cmd-import-options-rollback"></a>

 `--rollback <BOOLEAN>`   
Ramenez la pile à un état stable en cas de défaillance.  
Pour le spécifier`false`, 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` <a name="ref-cli-cmd-import-options-toolkit-stack-name"></a>

 `--toolkit-stack-name <STRING>`   
Nom de la pile du kit d'outils CDK à créer.  
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.  
La CLI CDK utilise cette valeur pour vérifier la version de votre stack bootstrap.

# `cdk init`
<a name="ref-cli-cmd-init"></a>

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

## Utilisation
<a name="ref-cli-cmd-init-usage"></a>

```
$ cdk init <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-init-args"></a><a name="ref-cli-cmd-init-args-template-type"></a>

 **Type de modèle**   
Type de modèle CDK à partir duquel initialiser un nouveau projet CDK.  
+  `app`— Modèle pour une application CDK.
+  `lib`— Modèle pour une bibliothèque de AWS construction.
+  `sample-app`— Exemple d'application CDK qui inclut certaines constructions.
 *Valeurs valides* : `app`, `lib`, `sample-app` 

## Options
<a name="ref-cli-cmd-init-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-init-options-generate-only"></a>

 `--generate-only <BOOLEAN>`   
Spécifiez cette option pour générer des fichiers de projet sans lancer d'opérations supplémentaires telles que la configuration d'un dépôt git, l'installation de dépendances ou la compilation du projet.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-init-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence de commande pour la `cdk init` commande.<a name="ref-cli-cmd-init-options-language"></a>

 `--language, -l <STRING>`   
Langue à utiliser pour le nouveau projet. Cette option peut être configurée dans le fichier de `cdk.json` configuration du projet ou `~/.cdk.json` sur votre machine de développement locale.  
 *Valeurs valides* :`csharp`,`fsharp`,`go`,`java`,`javascript`,`python`, `typescript` <a name="ref-cli-cmd-init-options-list"></a>

 `--list <BOOLEAN>`   
Répertoriez les types de modèles et les langues disponibles.

## Exemples
<a name="ref-cli-cmd-init-examples"></a>

### Répertorier les types de modèles et les langues disponibles
<a name="ref-cli-cmd-init-examples-1"></a>

```
$ cdk init --list
Available templates:
* app: Template for a CDK Application
   └─ cdk init app --language=[csharp|fsharp|go|java|javascript|python|typescript]
* lib: Template for a CDK Construct Library
   └─ cdk init lib --language=typescript
* sample-app: Example CDK Application with some constructs
   └─ cdk init sample-app --language=[csharp|fsharp|go|java|javascript|python|typescript]
```

### Créez une nouvelle application CDK à TypeScript partir du modèle de bibliothèque
<a name="ref-cli-cmd-init-examples-2"></a>

```
$ cdk init lib --language=typescript
```

# `cdk list`
<a name="ref-cli-cmd-list"></a>

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

## Utilisation
<a name="ref-cli-cmd-list-usage"></a>

```
$ cdk list <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-list-args"></a><a name="ref-cli-cmd-list-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK de votre application sur laquelle exécuter cette commande.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-list-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-list-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk list` commande.<a name="ref-cli-cmd-list-options-long"></a>

 `--long, -l <BOOLEAN>`   
Afficher les informations relatives à l' AWS environnement pour chaque pile.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-list-options-show-dependencies"></a>

 `--show-dependencies, -d <BOOLEAN>`   
Afficher les informations de dépendance des piles pour chaque pile.  
 *Valeur par défaut* : `false` 

## Exemples
<a name="ref-cli-cmd-list-examples"></a>

### Répertoriez toutes les piles dans l'application CDK « node bin/main.js »
<a name="ref-cli-cmd-list-examples-1"></a>

```
$ cdk list --app='node bin/main.js'
Foo
Bar
Baz
```

### Répertorier toutes les piles, y compris les détails de AWS l'environnement pour chaque pile
<a name="ref-cli-cmd-list-examples-"></a>

```
$ cdk list --app='node bin/main.js' --long
-
    name: Foo
    environment:
        name: 000000000000/bermuda-triangle-1
        account: '000000000000'
        region: bermuda-triangle-1
-
    name: Bar
    environment:
        name: 111111111111/bermuda-triangle-2
        account: '111111111111'
        region: bermuda-triangle-2
-
    name: Baz
    environment:
        name: 333333333333/bermuda-triangle-3
        account: '333333333333'
        region: bermuda-triangle-3
```

# `cdk metadata`
<a name="ref-cli-cmd-metadata"></a>

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

## Utilisation
<a name="ref-cli-cmd-metadata-usage"></a>

```
$ cdk metadata <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-metadata-args"></a><a name="ref-cli-cmd-metadata-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK de votre application pour laquelle afficher les métadonnées.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-metadata-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-metadata-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk metadata` commande.

# `cdk migrate`
<a name="ref-cli-cdk-migrate"></a>

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

Cette commande crée une nouvelle application CDK qui inclut une pile unique nommée avec la valeur que vous fournissez à l'aide `--stack-name` de cette commande. Vous pouvez configurer la source de migration à l'aide de `--from-scan``--from-stack`, ou`--from-path`.

Pour plus d'informations sur l'utilisation`cdk migrate`, voir [Migrer les ressources et les AWS CloudFormation modèles existants vers le AWS CDK](migrate.md).

**Note**  
La `cdk migrate` commande est expérimentale et pourrait subir des modifications importantes à l'avenir.

## Utilisation
<a name="ref-cli-cdk-migrate-usage"></a>

```
$ cdk migrate <options>
```

## Options
<a name="ref-cli-cdk-migrate-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).

### Options requises
<a name="ref-cli-cdk-migrate-options-required"></a><a name="ref-cli-cdk-migrate-options-stack-name"></a>

 `--stack-name <STRING>`   
Nom de la AWS CloudFormation pile qui sera créée dans l'application CDK après la migration.  
 *Obligatoire* : oui

### Options conditionnelles
<a name="ref-cli-cdk-migrate-options-conditional"></a><a name="ref-cli-cdk-migrate-options-from-path"></a>

 `--from-path <PATH>`   
Le chemin d'accès au AWS CloudFormation modèle à migrer. Fournissez cette option pour spécifier un modèle local.  
 *Obligatoire :* selon les conditions. Obligatoire en cas de migration à partir d'un AWS CloudFormation modèle local.<a name="ref-cli-cdk-migrate-options-from-scan"></a>

 `--from-scan <STRING>`   
Lorsque vous migrez des ressources déployées depuis un AWS environnement, utilisez cette option pour spécifier si une nouvelle analyse doit être lancée ou si la AWS CLI CDK doit utiliser la dernière analyse réussie.  
 *Obligatoire :* selon les conditions. Nécessaire lors de la migration à partir de AWS ressources déployées.  
 *Valeurs acceptées* :`most-recent`, `new` <a name="ref-cli-cdk-migrate-options-from-stack"></a>

 `--from-stack <BOOLEAN>`   
Fournissez cette option pour migrer à partir d'une AWS CloudFormation pile déployée. `--stack-name`À utiliser pour spécifier le nom de la AWS CloudFormation pile déployée.  
 *Obligatoire :* selon les conditions. Obligatoire en cas de migration depuis une AWS CloudFormation pile déployée.

### Options facultatives
<a name="ref-cli-cdk-migrate-options-optional"></a><a name="ref-cli-cdk-migrate-options-account"></a>

 `--account <STRING>`   
Le compte à partir duquel récupérer le modèle de AWS CloudFormation pile.  
 *Obligatoire* : non  
 *Par défaut* : la CLI AWS CDK obtient les informations de compte à partir de sources par défaut.<a name="ref-cli-cdk-migrate-options-compress"></a>

 `--compress <BOOLEAN>`   
Fournissez cette option pour compresser le projet CDK généré dans un `ZIP` fichier.  
 *Obligatoire* : non<a name="ref-cli-cdk-migrate-options-filter"></a>

 `--filter <ARRAY>`   
À utiliser lors de la migration des ressources déployées depuis un AWS compte et une AWS région. Cette option spécifie un filtre pour déterminer les ressources déployées à migrer.  
Cette option accepte un tableau de paires clé-valeur, où la **clé** représente le type de filtre et la **valeur** représente la valeur à filtrer.  
Les clés suivantes sont acceptées :  
+  `resource-identifier`— Identifiant de la ressource. La valeur peut être l'identifiant logique ou physique de la ressource. Par exemple, `resource-identifier="ClusterName"`.
+  `resource-type-prefix`— Le préfixe du type de AWS CloudFormation ressource. Par exemple, spécifiez `resource-type-prefix="AWS::DynamoDB::"` de filtrer toutes les ressources Amazon DynamoDB.
+  `tag-key`— La clé d'une balise de ressource. Par exemple, `tag-key="myTagKey"`.
+  `tag-value`— La valeur d'une balise de ressource. Par exemple, `tag-value="myTagValue"`.
Fournissez plusieurs paires clé-valeur pour la logique `AND` conditionnelle. L'exemple suivant filtre toute ressource DynamoDB étiquetée `myTagKey` avec comme clé de balise :. `--filter resource-type-prefix="AWS::DynamoDB::", tag-key="myTagKey"`  
Fournissez l'`--filter`option plusieurs fois dans une seule commande pour la logique `OR` conditionnelle. L'exemple suivant filtre toute ressource qui est une ressource DynamoDB ou qui est étiquetée comme clé `myTagKey` de balise :. `--filter resource-type-prefix="AWS::DynamoDB::" --filter tag-key="myTagKey"`  
 *Obligatoire* : non<a name="ref-cli-cdk-migrate-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk migrate` commande.<a name="ref-cli-cdk-migrate-options-language"></a>

 `--language <STRING>`   
Langage de programmation à utiliser pour le projet CDK créé lors de la migration.  
 *Obligatoire* : non  
 *Valeurs valides* :`typescript`,`python`,`java`,`csharp`,`go`.  
 *Par défaut* : `typescript` <a name="ref-cli-cdk-migrate-options-output-path"></a>

 `--output-path <PATH>`   
Le chemin de sortie pour le projet CDK migré.  
 *Obligatoire* : non  
 *Par défaut* : par défaut, la CLI AWS CDK utilisera votre répertoire de travail actuel.<a name="ref-cli-cdk-migrate-options-region"></a>

 `--region <STRING>`   
La AWS région à partir de laquelle récupérer le modèle de AWS CloudFormation pile.  
 *Obligatoire* : non  
 *Par défaut* : la CLI AWS CDK obtient les informations de AWS région à partir de sources par défaut.

## Exemples
<a name="ref-cli-cdk-migrate-examples"></a>

### Exemple simple de migration à partir d'une pile CloudFormation
<a name="ref-cli-cdk-migrate-examples-1"></a>

Migrez à partir d'une CloudFormation pile déployée dans un AWS environnement spécifique à l'aide de`--from-stack`. Indiquez `--stack-name` le nom de votre nouvelle pile de CDK. Voici un exemple de migration `myCloudFormationStack` vers une nouvelle application CDK qui utilise : TypeScript

```
$ cdk migrate --language typescript --from-stack --stack-name 'myCloudFormationStack'
```

### Exemple simple de migration à partir d'un modèle local CloudFormation
<a name="ref-cli-cdk-migrate-examples-2"></a>

Migrez à partir d'un CloudFormation modèle JSON ou YAML local à l'aide `--from-path` de. Indiquez `--stack-name` le nom de votre nouvelle pile de CDK. Voici un exemple de création d'une nouvelle application CDK TypeScript qui inclut une `myCloudFormationStack` pile provenant d'un `template.json` fichier local :

```
$ cdk migrate --stack-name "myCloudFormationStack" --language typescript --from-path "./template.json"
```

### Exemple simple de migration à partir de ressources déployées AWS
<a name="ref-cli-cdk-migrate-examples-3"></a>

Migrez AWS les ressources déployées depuis un AWS environnement spécifique qui ne sont pas associées à une CloudFormation pile à l'aide de`--from-scan`. La CLI CDK utilise IaC generator service permettant de rechercher des ressources et de générer un modèle. Ensuite, la CLI CDK référence le modèle pour créer la nouvelle application CDK. Voici un exemple qui crée une nouvelle application CDK TypeScript avec une nouvelle `myCloudFormationStack` pile contenant des ressources migrées AWS  :

```
$ cdk migrate --language typescript --from-scan --stack-name "myCloudFormationStack"
```

# `cdk notices`
<a name="ref-cli-cmd-notices"></a>

Afficher les notifications relatives à votre application CDK.

Les notifications peuvent inclure des messages importants concernant les failles de sécurité, les régressions et l'utilisation de versions non prises en charge.

Cette commande affiche les notifications pertinentes, qu'elles aient été reconnues ou non. Les notifications pertinentes peuvent également apparaître après chaque commande par défaut.

Vous pouvez supprimer les notifications de différentes manières :
+ Par le biais des options de commande. Voici un exemple :

  ```
  $ cdk deploy --no-notices
  ```
+ Supprimez toutes les notifications indéfiniment en fonction du contexte dans le `cdk.json` fichier du projet :

  ```
  {
    "notices": false,
    "context": {
      // ...
    }
  }
  ```
+ Accusez réception de chaque notification à l'aide de la `cdk acknowledge` commande.

## Utilisation
<a name="ref-cli-cmd-notices-usage"></a>

```
$ cdk notices <options>
```

## Options
<a name="ref-cli-cmd-notices-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-notices-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk notices` commande.

## Exemples
<a name="ref-cli-cmd-notices-examples"></a>

### Exemple d'avis par défaut qui s'affiche après l'exécution de la commande cdk deploy
<a name="ref-cli-cmd-notices-examples-1"></a>

```
$ cdk deploy

... # Normal output of the command

NOTICES

16603   Toggling off auto_delete_objects for Bucket empties the bucket

        Overview: If a stack is deployed with an S3 bucket with
                  auto_delete_objects=True, and then re-deployed with
                  auto_delete_objects=False, all the objects in the bucket
                  will be deleted.

        Affected versions: <1.126.0.

        More information at: https://github.com/aws/aws-cdk/issues/16603


17061   Error when building EKS cluster with monocdk import

        Overview: When using monocdk/aws-eks to build a stack containing
                  an EKS cluster, error is thrown about missing
                  lambda-layer-node-proxy-agent/layer/package.json.

        Affected versions: >=1.126.0 <=1.130.0.

        More information at: https://github.com/aws/aws-cdk/issues/17061


If you don’t want to see an notice anymore, use "cdk acknowledge ID". For example, "cdk acknowledge 16603"
```

### Exemple simple d'exécution de la commande cdk notices
<a name="ref-cli-cmd-notices-examples-2"></a>

```
$ cdk notices

NOTICES

16603   Toggling off auto_delete_objects for Bucket empties the bucket

        Overview: if a stack is deployed with an S3 bucket with
                  auto_delete_objects=True, and then re-deployed with
                  auto_delete_objects=False, all the objects in the bucket
                  will be deleted.

        Affected versions: framework: <=2.15.0 >=2.10.0

        More information at: https://github.com/aws/aws-cdk/issues/16603


If you don’t want to see a notice anymore, use "cdk acknowledge <id>". For example, "cdk acknowledge 16603"
```

# `cdk refactor`
<a name="ref-cli-cmd-refactor"></a>

**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](refactor.md).

## Utilisation
<a name="ref-cli-cmd-refactor-usage"></a>

```
$ cdk refactor <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-refactor-args"></a><a name="ref-cli-cmd-refactor-args-stack-id"></a>

 **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
<a name="ref-cli-cmd-refactor-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-refactor-options-dry-run"></a>

 `--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.<a name="ref-cli-cmd-refactor-options-force"></a>

 `--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.<a name="ref-cli-cmd-refactor-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk refactor` commande.<a name="ref-cli-cmd-refactor-options-override-file"></a>

 `--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"
            }
        }
    ]
}
```<a name="ref-cli-cmd-refactor-options-revert"></a>

 `--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.

# `cdk rollback`
<a name="ref-cli-cmd-rollback"></a>

Utilisez la commande d'interface de ligne de commande (CLI) `cdk rollback` du AWS Cloud Development Kit (AWS CDK) pour rétablir le dernier état stable d'une pile AWS CloudFormation défaillante ou interrompue.

**Note**  
Pour utiliser cette commande, la version 23 du modèle bootstrap doit être déployée dans votre environnement. Pour plus d'informations, consultez l'[historique des versions du modèle Bootstrap](bootstrapping-env.md#bootstrap-template-history).

Lorsque vous déployez à l'aide de`cdk deploy`, la CLI CDK annulera par défaut un déploiement ayant échoué. Si vous spécifiez `--no-rollback` avec`cdk deploy`, vous pouvez ensuite utiliser la `cdk rollback` commande pour annuler manuellement un déploiement qui a échoué. Cela initiera un retour au dernier état stable de votre pile.

## Utilisation
<a name="ref-cli-cmd-rollback-usage"></a>

```
$ cdk rollback <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-rollback-args"></a><a name="ref-cli-cmd-rollback-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK depuis votre application jusqu'à la restauration.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-rollback-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-rollback-options-all"></a>

 `--all <BOOLEAN>`   
Annulez toutes les piles dans votre application CDK.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-rollback-options-force"></a>

 `--force, -f <BOOLEAN>`   
Lors de l'utilisation`cdk rollback`, certaines ressources peuvent ne pas être annulées. Proposez cette option pour forcer l'annulation de toutes les ressources. Ce comportement revient à fournir l'`--orphan`option pour chaque ressource de votre pile.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-rollback-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk rollback` commande.<a name="ref-cli-cmd-rollback-options-orphan"></a>

 `--orphan <LogicalId>`   
Lors de l'utilisation`cdk rollback`, certaines ressources peuvent ne pas être annulées. Dans ce cas, vous pouvez essayer de forcer l'annulation d'une ressource en utilisant cette option et en fournissant l'ID logique de la ressource dont la restauration n'a pas pu être annulée.  
Cette option peut être fournie plusieurs fois en une seule commande. Voici un exemple :  

```
$ cdk rollback MyStack --orphan MyLambdaFunction --orphan MyLambdaFunction2
```
Pour forcer l'annulation de toutes les ressources, utilisez plutôt l'`--force`option.<a name="ref-cli-cmd-rollback-options-toolkit-stack-name"></a>

 `--toolkit-stack-name <STRING>`   
Nom de la pile CDK Toolkit existante avec laquelle l'environnement est amorcé.  
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.  
La CLI CDK utilise cette valeur pour vérifier la version de votre stack bootstrap.<a name="ref-cli-cmd-rollback-options-validate-bootstrap-version"></a>

 `--validate-bootstrap-version <BOOLEAN>`   
Spécifiez s'il faut valider la version de la pile bootstrap. Indiquez `--validate-bootstrap-version=false` ou `--no-validate-bootsrap-version` désactivez ce comportement.  
 *Valeur par défaut* : `true` 

# `cdk synthesize`
<a name="ref-cli-cmd-synth"></a>

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

Les assemblages cloud sont des fichiers qui incluent tout ce dont vous avez besoin pour déployer votre application AWS dans votre environnement. Par exemple, il inclut un CloudFormation modèle pour chaque pile de votre application, ainsi qu'une copie des fichiers ou des images Docker auxquels vous faites référence dans votre application.

Si votre application contient une seule pile ou si une seule pile est fournie comme argument, le CloudFormation modèle sera également affiché dans la sortie standard (`stdout`) au format YAML.

Si votre application contient plusieurs piles, elle `cdk synth` synthétisera l'assemblage du cloud en. `cdk.out`

## Utilisation
<a name="ref-cli-cmd-synth-usage"></a>

```
cdk synthesize <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-synth-args"></a><a name="ref-cli-cmd-synth-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK de votre application à synthétiser.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-synth-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-synth-options-exclusively"></a>

 `--exclusively, -e <BOOLEAN>`   
Synthétisez uniquement les piles demandées, n'incluez pas les dépendances.<a name="ref-cli-cmd-synth-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk synthesize` commande.<a name="ref-cli-cmd-synth-options-quiet"></a>

 `--quiet, -q <BOOLEAN>`   
Ne publiez pas le CloudFormation modèle vers`stdout`.  
Cette option peut être configurée dans le `cdk.json` fichier du projet CDK. Voici un exemple :  

```
{
   "quiet": true
}
```
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-synth-options-validation"></a>

 `--validation <BOOLEAN>`   
Validez les CloudFormation modèles générés après la synthèse en effectuant des vérifications supplémentaires.  
Vous pouvez également configurer cette option par le biais de l'`validateOnSynth`attribut ou de la variable d'`CDK_VALIDATION`environnement.  
 *Valeur par défaut* : `true` 

## Exemples
<a name="ref-cli-cmd-synth-examples"></a>

### Synthétiser l'assemblage cloud pour une pile CDK avec un ID logique MyStackName et générer le CloudFormation modèle sur stdout
<a name="ref-cli-cmd-synth-examples-1"></a>

```
$ cdk synth MyStackName
```

### Synthétisez l'assemblage cloud pour toutes les piles dans une application CDK et enregistrez-les dans cdk.out
<a name="ref-cli-cmd-synth-examples-2"></a>

```
$ cdk synth
```

### Synthétisez l'assemblage du cloud pour les MyStackName dépendances, mais n'incluez pas
<a name="ref-cli-cmd-synth-examples-3"></a>

```
$ cdk synth MyStackName --exclusively
```

### Synthétisez l'assemblage cloud pour MyStackName, mais ne le publiez pas sur CloudFormation stdout
<a name="ref-cli-cmd-synth-examples-4"></a>

```
$ cdk synth MyStackName --quiet
```

# `cdk watch`
<a name="ref-cli-cmd-watch"></a>

Surveillez en permanence un projet AWS CDK local pour détecter les modifications nécessaires aux déploiements et aux 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 pour`cdk deploy --watch`.

Pour terminer une `cdk watch` session, interrompez le processus en appuyant sur`Ctrl+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 sortie du CDK et le `node_modules` répertoire.

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

Si votre code CDK 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.

**Important**  
Cette commande est destinée à un déploiement rapide pendant la phase de développement des applications CDK et n'est pas recommandée pour les déploiements de production.

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

## Usage
<a name="ref-cli-cmd-watch-usage"></a>

```
$ cdk watch <arguments> <options>
```

## Arguments
<a name="ref-cli-cmd-watch-args"></a><a name="ref-cli-cmd-watch-args-stack-name"></a>

 **ID de pile CDK**   
L'ID de construction de la pile CDK de votre application à surveiller.  
 *Type* : chaîne  
 *Obligatoire* : non

## Options
<a name="ref-cli-cmd-watch-options"></a>

Pour une liste des options globales qui fonctionnent avec toutes les commandes de la CLI CDK, consultez la section [Options globales](ref-cli-cmd.md#ref-cli-cmd-options).<a name="ref-cli-cmd-watch-options-build-exclude"></a>

 `--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* : `[]` <a name="ref-cli-cmd-watch-options-change-set-name"></a>

 `--change-set-name <STRING>`   
Nom du jeu de CloudFormation modifications à créer.<a name="ref-cli-cmd-watch-options-concurrency"></a>

 `--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 de taux du AWS compte.  
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` <a name="ref-cli-cmd-watch-options-exclusively"></a>

 `--exclusively, -e <BOOLEAN>`   
Déployez uniquement les piles demandées et n'incluez pas les dépendances.<a name="ref-cli-cmd-watch-options-force"></a>

 `--force, -f <BOOLEAN>`   
Déployez toujours des piles, même si les modèles sont identiques.  
 *Valeur par défaut* : `false` <a name="ref-cli-cmd-watch-options-help"></a>

 `--help, -h <BOOLEAN>`   
Afficher les informations de référence relatives à la `cdk watch` commande.<a name="ref-cli-cmd-watch-options-hotswap"></a>

 `--hotswap <BOOLEAN>`   
Par défaut, `cdk watch` utilise des déploiements hotswap lorsque cela est possible pour mettre à jour vos ressources. La CLI CDK 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` <a name="ref-cli-cmd-watch-options-hotswap-fallback"></a>

 `--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.<a name="ref-cli-cmd-watch-options-logs"></a>

 `--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 vers`stdout`.  
 *Valeur par défaut* : `true` <a name="ref-cli-cmd-watch-options-progress"></a>

 `--progress <STRING>`   
Configurez la manière dont la CLI CDK 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` <a name="ref-cli-cmd-watch-options-rollback"></a>

 `--rollback <BOOLEAN>`   
Pendant le déploiement, si une ressource ne parvient pas à être créée ou mise à jour, le déploiement reviendra à son dernier état stable avant le retour de la CLI CDK. 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, la CLI CDK laissera les modifications apportées jusqu'à ce point en place et reviendra. Cela peut être utile dans les environnements de développement dans lesquels vous effectuez des itérations rapides.  
À quel moment`false`, 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` <a name="ref-cli-cmd-watch-options-toolkit-stack-name"></a>

 `--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.  
La CLI CDK utilise cette valeur pour vérifier la version de votre stack bootstrap.

## Exemples
<a name="ref-cli-cmd-watch-examples"></a>

### Surveillez les modifications apportées à une pile de CDK avec un ID DevelopmentStack logique
<a name="ref-cli-cmd-watch-examples-1"></a>

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

 ✅  DevelopmentStack
```

### Configurer un fichier cdk.json indiquant les éléments à inclure et à exclure de la surveillance des modifications
<a name="ref-cli-cmd-watch-examples-2"></a>

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

### Créez un projet CDK à l'aide de Java avant le déploiement en configurant le fichier cdk.json
<a name="ref-cli-cmd-watch-examples-3"></a>

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