cdk gc - Kit de desenvolvimento em nuvem da AWS (CDK da AWS) v2
UsoArgumentosOpçõesExemplos

Este é o Guia do desenvolvedor do AWS CDK v2. O CDK v1 antigo entrou em manutenção em 1º de junho de 2022 e encerrou o suporte em 1º de junho de 2023.

cdk gc

Use o comando cdk gc da interface de linha de comandos (CLI) do kit de desenvolvimento em nuvem da AWS (CDK da AWS) para realizar a coleta de resíduos em ativos não utilizados armazenados nos recursos da sua pilha de bootstrapping. Use o comando a seguir para visualizar, gerenciar e excluir ativos que não sejam mais necessários.

Para ativos do Amazon Simple Storage Service (Amazon S3), a CLI do CDK verificará os modelos existentes do AWS CloudFormation no mesmo ambiente para ver se eles são referenciados. Se não forem referenciados, eles serão considerados não utilizados e elegíveis para ações de coleta de resíduos.

Atenção

O comando cdk gc está em desenvolvimento para o AWS CDK. Os atributos atuais desse comando são considerados prontos para produção e seguros de usar. Contudo, o escopo desse comando e seus atributos estão sujeitos a alterações. Sendo assim, é necessário se cadastrar fornecendo a opção unstable=gc de usar esse comando.

Uso

$ cdk gc <arguments> <options>

Argumentos

AWS Ambiente do

O ambiente de destino AWS no qual realizar ações de coleta de resíduos.

Ao fornecer um ambiente, use o formato a seguir: aws://<account-id>/<region>. Por exemplo, aws://<123456789012>/<us-east-1>.

Esse argumento pode ser fornecido várias vezes em um único comando para executar ações de coleta de resíduos em vários ambientes.

Por padrão, a CLI do CDK executará ações de coleta de resíduos em todos os ambientes que você referenciar em sua aplicação do CDK ou fornecer como argumentos. Se você não fornecer um ambiente, a CLI do CDK determinará o ambiente a partir das fontes padrão. Essas fontes incluem ambientes que você especifica usando a opção --profile, variáveis de ambiente ou fontes da AWS CLI padrão.

Opções

Para obter uma lista das opções globais que funcionam com todos os comandos da CLI do CDK, consulte Opções globais.

--action <STRING>

A ação que cdk gc executa em seus ativos durante uma coleta de resíduos.

  • delete-tagged: exclui ativos com tag de uma data dentro do intervalo de dias de buffer fornecido por você, mas não aplica tag em ativos não utilizados recém-identificados.

  • full: executa todas as ações de coleta de resíduos. Isso inclui excluir ativos dentro do intervalo de dias de buffer que você fornece e aplicar tags em ativos não utilizados recém-identificados.

  • print: exibe o número de ativos não utilizados no prompt de comando, mas não faz nenhuma alteração real em seu ambiente da AWS.

  • tag: aplica tag em todos os ativos não utilizados recém-identificados, mas não exclui nenhum ativo dentro do intervalo de dias de buffer que você fornece.

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

Valor padrão: full

--bootstrap-stack-name <STRING>

O nome da pilha de bootstrapping do CDK no seu ambiente da AWS. Forneça essa opção se você personalizou o nome da pilha de bootstrapping. Se você estiver usando o nome da pilha CDKToolkit padrão, não é necessário fornecer essa opção.

Valor padrão: CDKToolkit

--confirm <BOOLEAN>

Especifica se a CLI do CDK solicitará sua confirmação manual antes de excluir quaisquer ativos.

Especifica false para excluir ativos automaticamente, sem solicitar a confirmação manual.

Valor padrão: true

--created-buffer-days <NUMBER>

O número de dias que um ativo deve existir antes de ser elegível para ações de coleta de resíduos.

Quando você fornece um número, os ativos que não existiram além do número especificado de dias são filtrados das ações de coleta de resíduos.

Valor padrão: 1

--help, -h <BOOLEAN>

Mostrar as informações de referência do comando cdk gc.

--rollback-buffer-days <NUMBER>

O número de dias que um ativo deve receber uma tag de isolado antes de ser elegível para ações de coleta de resíduos.

Quando você fornece um número, a CLI do CDK aplica uma tag nos ativos não utilizados com a data atual em vez de excluí-los. A CLI do CDK também verificará se algum ativo recebeu tag durante as execuções anteriores do comando cdk gc. Os ativos que anteriormente receberam a tag e que estejam dentro do intervalo de dias de buffer que você fornece serão excluídos.

Valor padrão: 0

--type <STRING>

O tipo de recurso de bootstrapping em sua pilha de bootstrapping para realizar ações de coleta de resíduos.

  • all: executa ações de coleta de resíduos em todos os recursos que tenha sofrido bootstrapping.

  • ecr: executa ações de coleta de resíduos em ativos no repositório Amazon Elastic Container Registry (Amazon ECR) da pilha de bootstrapping.

  • s3: executa ações de coleta de resíduos em ativos no bucket do Amazon S3 de sua pilha de bootstrapping.

Valores aceitos: all, ecr, s3

Valor padrão: all

--unstable <STRING>

Permita o uso de comandos da CLI do CDK que ainda estão em desenvolvimento.

Essa opção é necessária para usar qualquer comando da CLI do CDK que ainda esteja em desenvolvimento e sujeito a alterações.

Essa opção pode ser fornecida várias vezes em um único comando.

Para usar cdk gc, forneça --unstable=gc.

Exemplos

Exemplos básicos

O exemplo a seguir solicita uma confirmação manual para realizar ações padrão de coleta de resíduos em ativos no bucket Amazon S3 da sua pilha de bootstrapping:

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

O exemplo a seguir executa ações de coleta de resíduos em uma faixa de ativos no bucket do Amazon S3 da sua pilha de bootstrapping: Essa faixa inclui ativos previamente marcados com tag por cdk gc por mais de 30 dias e foram criados com 10 dias ou mais. Esse comando solicitará a confirmação manual antes de excluir qualquer ativo:

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

O exemplo a seguir executa a ação de excluir ativos previamente marcados com tag no bucket do Amazon S3 da sua pilha de bootstrapping que não foram utilizados por mais de 30 dias:

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