cdk gc - AWS Cloud Development Kit (AWS CDK) v2
UsoArgumentosOpcionesEjemplos

Esta es la segunda versión de la Guía para desarrolladores de AWS CDK. La primera versión del CDK pasó a la etapa de mantenimiento el 1.° de junio de 2022 y no cuenta con soporte desde el 1.° de junio de 2023.

cdk gc

Use el comando cdk gc de la interfaz de línea de comandos (CLI) del AWS Cloud Development Kit (AWS CDK) para recolectar basura en los activos no utilizados almacenados en los recursos de su pila de arranque. Utilice este comando para ver, administrar y eliminar los activos que ya no necesite.

En el caso de los activos de Amazon Simple Storage Service (Amazon S3), la CLI de CDK comprobará las plantillas de AWS CloudFormation existentes en el mismo entorno para ver si se hace referencia a estas. Si no se hace referencia a ellos, se considerarán no utilizados y aptos para las acciones de recopilación de elementos no utilizados.

aviso

El comando cdk gc está en desarrollo para el AWS CDK. Se considera que las funciones actuales de este comando están listas para la producción y son seguras de usar. Sin embargo, el alcance de este comando y sus funciones están sujetos a cambios. Por lo tanto, debe suscribirse proporcionando la opción unstable=gc usar este comando.

Uso

$ cdk gc <arguments> <options>

Argumentos

AWS Entorno de

El entorno de destino de AWS en el que se realizarán las acciones de recopilación de elementos no utilizados.

Al proporcionar un entorno, utilice el siguiente formato: aws://<account-id>/<region>. Por ejemplo, aws://<123456789012>/<us-east-1>.

Este argumento se puede proporcionar varias veces en un solo comando para realizar acciones de recopilación de elementos no utilizados en varios entornos.

De forma predeterminada, la CLI de CDK realizará acciones de recopilación de elementos no utilizados en todos los entornos a los que haga referencia en su aplicación de CDK o que proporcione como argumentos. Si no proporciona un entorno, la CLI de CDK determinará el entorno a partir de las fuentes predeterminadas. Estas fuentes incluyen los entornos que especifique mediante la opción --profile, las variables de entorno o las fuentes de AWS CLI predeterminadas.

Opciones

Para obtener una lista de las opciones globales que funcionan con todos los comandos de la CLI de CDK, consulte Opciones globales.

--action <STRING>

La acción que cdk gc realiza en sus activos durante una recopilación de elementos no utilizados.

  • delete-tagged: elimina los activos que se han etiquetado con una fecha dentro del intervalo de días de almacenamiento que usted proporciona, pero no etiqueta los activos no utilizados recientemente identificados.

  • full: realiza todas las acciones de recopilación de elementos no utilizados. Esto incluye eliminar los activos dentro del intervalo de días de almacenamiento que usted proporcione y etiquetar los activos que no se utilizaron y están recientemente identificados.

  • print: muestra el número de activos no utilizados en la línea de comandos, pero no realiza ningún cambio real en el entorno AWS.

  • tag: etiqueta los activos no utilizados que se hayan identificado recientemente, pero no los elimina dentro del intervalo de días de almacenamiento que usted haya indicado.

Valores aceptados: delete-tagged, full, print, tag

Valor predeterminado: full

--bootstrap-stack-name <STRING>

El nombre de la pila de arranque de CDK en su entorno de AWS. Proporcione esta opción si ha personalizado el nombre de la pila de arranque. Si utiliza el nombre de pila CDKToolkit predeterminado, no tendrá que proporcionar esta opción.

Valor predeterminado: CDKToolkit

--confirm <BOOLEAN>

Especifique si la CLI de CDK le solicitará una confirmación manual antes de eliminar cualquier activo.

Especifique false para que se eliminen automáticamente los activos sin solicitar una confirmación manual.

Valor predeterminado: true

--created-buffer-days <NUMBER>

El número de días que debe existir un activo antes de que pueda ser objeto de acciones de recopilación de elementos no utilizados.

Al proporcionar un número, los activos que no hayan existido más allá del número de días especificado se excluyen de las acciones de recopilación de elementos no utilizados.

Valor predeterminado: 1

--help, -h <BOOLEAN>

Muestra la información de referencia del comando cdk gc.

--rollback-buffer-days <NUMBER>

El número de días que debe etiquetar como aislado un activo antes de que pueda ser objeto de acciones de recopilación de elementos no utilizados.

Al proporcionar un número, la CLI de CDK etiquetará los activos no utilizados con la fecha actual en lugar de eliminarlos. La CLI de CDK también comprobará si se ha etiquetado algún activo durante las ejecuciones anteriores del comando cdk gc. Se eliminarán los activos etiquetados previamente que se encuentren dentro del intervalo de días de almacenamiento que haya proporcionado.

Valor predeterminado: 0

--type <STRING>

El tipo de recurso de arranque de la pila de arranque en el que se van a realizar acciones de recopilación de elementos no utilizados.

  • all: realice acciones de recopilación de elementos no utilizados en todos los recursos de arranque.

  • ecr: realice acciones de recopilación de elementos no utilizados en el repositorio Amazon Elastic Container Registry (Amazon ECR) de su pila de arranque.

  • s3: realice acciones de recopilación de elementos no utilizados en los activos del bucket de Amazon S3 de su pila de arranque.

Valores aceptados: all, ecr, s3

Valor predeterminado: all

--unstable <STRING>

Permita el uso de comandos de la CLI de CDK que aún están en desarrollo.

Esta opción es necesaria para usar cualquier comando de la CLI de CDK que aún esté en desarrollo y esté sujeto a cambios.

Esta opción se puede proporcionar varias veces en un mismo comando.

Para utilizar cdk gc, proporcione --unstable=gc.

Ejemplos

Ejemplos básicos

En el siguiente ejemplo, se le solicita una confirmación manual para realizar las acciones de recopilación de elementos no utilizados predeterminadas en los activos del bucket de Amazon S3 de su pila de arranque:

$ 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)?

El siguiente ejemplo realiza las acciones de recopilación de elementos no utilizados predeterminadas en los activos del bucket de Amazon S3 de su pila de arranque: Este rango incluye los activos que han sido etiquetados anteriormente como cdk gc durante más de 30 días y que se han creado hace 10 días o más. Este comando solicitará una confirmación manual antes de eliminar cualquier activo:

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

El siguiente ejemplo lleva a cabo la acción de eliminar los activos previamente etiquetados en el bucket de Amazon S3 de su pila de arranque que no se hayan utilizado durante más de 30 días:

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