Esta es la guía para desarrolladores de AWS CDK v2. 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.
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
cdk gc
Usa el comando de la interfaz de línea de comandos (CLI) del AWS Cloud Development Kit (AWS CDK) cdk gc para recolectar basura en los activos no utilizados almacenados en los recursos de tu pila de bootstrap. Usa este comando para ver, administrar y eliminar los activos que ya no necesitas.
En el caso de los activos de Amazon Simple Storage Service (Amazon S3), la CLI del CDK comprobará AWS CloudFormation las plantillas existentes en el mismo entorno para comprobar si están referenciadas. Si no se hace referencia a ellos, se considerarán no utilizados y aptos para las acciones de recolección de basura.
aviso
El cdk gc comando 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 unstable=gc opción de usar este comando.
Uso
$ cdk gc <arguments> <options>
Argumentos
- AWS entorno
-
El AWS entorno de destino en el que se realizarán las acciones de recolección de basura.
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 recolección de basura en varios entornos.
De forma predeterminada, la CLI de CDK realizará acciones de recolección de basura 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
--profileopción, las variables de entorno o las fuentes AWS CLI predeterminadas.
Opciones
Para obtener una lista de las opciones globales que funcionan con todos los comandos CLI de CDK, consulte Opciones globales.
-
--action <STRING> -
La acción que se
cdk gcrealiza en sus activos durante una recolección de basura.-
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 recolección de basura. Esto incluye eliminar los activos dentro del intervalo de días de almacenamiento que usted proporcione y etiquetar los activos no utilizados 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 AWS entorno. -
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,tagValor predeterminado:
full -
-
--bootstrap-stack-name <STRING> -
El nombre de la pila de bootstrap de CDK de su AWS entorno. Proporcione esta opción si ha personalizado el nombre de la pila de bootstrap. Si utilizas el nombre de
CDKToolkitpila predeterminado, no tienes 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
falseque 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 recolección de basura.
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 recolección de basura.
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 un activo debe etiquetarse como aislado antes de que pueda ser objeto de acciones de recolección de basura.
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
cdk gccomando. Se eliminarán los activos previamente etiquetados que se encuentren dentro del intervalo de días de almacenamiento que usted 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 recolección de basura.
-
all— Realice acciones de recolección de basura en todos los recursos de arranque. -
ecr— Realice acciones de recolección de basura en los activos del repositorio Amazon Elastic Container Registry (Amazon ECR) de su pila de bootstrap. -
s3— Realice acciones de recolección de basura en los activos del depósito de Amazon S3 de su pila de bootstrap.
Valores aceptados:
all,,ecrs3Valor predeterminado:
all -
-
--unstable <STRING> -
Permita el uso de comandos CLI de CDK que aún están en desarrollo.
Esta opción es necesaria para usar cualquier comando 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 utilizarla
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 recolección de basura predeterminadas en los activos del bucket de Amazon S3 de su pila de 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)?
En el siguiente ejemplo, se realizan acciones de recolección de basura en una serie de activos del bucket de Amazon S3 de su pila de bootstrap. Este rango incluye los activos que han sido etiquetados anteriormente 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 depósito de Amazon S3 de su pila de bootstrap 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
