cdk gc - AWS Kit de développement Cloud (AWS CDK) v2
UtilisationArgumentsOptionsExemples

Ceci est le guide du développeur du AWS CDK v2. L'ancien CDK v1 est entré en maintenance le 1er juin 2022 et a pris fin le 1er juin 2023.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

cdk gc

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=gcoption d'utiliser cette commande.

Utilisation

$ cdk gc <arguments> <options>

Arguments

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'--profileoption, les variables d'environnement ou les sources AWS CLI par défaut.

Options

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

--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-taggedfull,print, tag

Valeur par défaut : full

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

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

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

--help, -h <BOOLEAN>

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

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

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

--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 utilisercdk gc, fournissez--unstable=gc.

Exemples

Exemples de base

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