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.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# AWS Referência de comandos CLI do CDK
<a name="ref-cli-cmd"></a>

Esta seção contém informações de referência de comando para a interface de linha de comando (CLI) do AWS Cloud Development Kit (AWS CDK). A CLI do CDK também é conhecida como Kit de Ferramentas CDK.

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

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

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

 ` acknowledge ack `   
Reconheça um aviso pelo número do problema e oculte-o de ser exibido novamente.<a name="ref-cli-cmd-commands-bootstrap"></a>

 ` bootstrap `   
Prepare um AWS ambiente para implantações de CDK implantando a pilha de bootstrap CDK, chamada, no ambiente. `CDKToolkit` AWS <a name="ref-cli-cmd-commands-context"></a>

 ` context `   
Gerencie valores de contexto em cache para sua aplicação do CDK.<a name="ref-cli-cmd-commands-deploy"></a>

 ` deploy `   
Implante uma ou mais pilhas de CDK em seu AWS ambiente.<a name="ref-cli-cmd-commands-destroy"></a>

 ` destroy `   
Exclua uma ou mais pilhas de CDK do seu AWS ambiente.<a name="ref-cli-cmd-commands-diff"></a>

 ` diff `   
Fazer uma comparação para ver as mudanças na infraestrutura entre as pilhas CDK.<a name="ref-cli-cmd-commands-docs"></a>

 ` docs doc `   
Abrir a documentação CDK no seu navegador.<a name="ref-cli-cmd-commands-doctor"></a>

 ` doctor `   
Inspecionar e exibir informações úteis sobre seu projeto do CDK local e ambiente de desenvolvimento.<a name="ref-cli-cmd-commands-drift"></a>

 ` drift `   
Detecte o desvio de configuração dos recursos que você define, gerencia e implanta usando o CDK.<a name="ref-cli-cmd-commands-flags"></a>

 ` flags `   
Visualize e modifique suas configurações de sinalizadores de atributos para a CLI do CDK.<a name="ref-cli-cmd-commands-import"></a>

 ` import `   
Use importações AWS CloudFormation de recursos para importar AWS recursos existentes em uma pilha de CDK.<a name="ref-cli-cmd-commands-init"></a>

 ` init `   
Criar um novo projeto do CDK a partir de um modelo.<a name="ref-cli-cmd-commands-list"></a>

 ` list, ls `   
Listar todas as pilhas CDK e suas dependências em uma aplicação CDK.<a name="ref-cli-cmd-commands-metadata"></a>

 ` metadata `   
Exibir metadados associados a uma pilha do CDK.<a name="ref-cli-cmd-commands-migrate"></a>

 ` migrate `   
Migre AWS recursos, AWS CloudFormation pilhas e AWS CloudFormation modelos para um novo projeto CDK.<a name="ref-cli-cmd-commands-notices"></a>

 ` notices `   
Exibir avisos para sua aplicação CDK.<a name="ref-cli-cmd-commands-publish-assets"></a>

 ` publish-assets `   
Publique ativos para a pilha de CDK especificada em seus respectivos destinos sem realizar uma implantação.<a name="ref-cli-cmd-commands-refactor"></a>

 ` refactor `   
Preserve os recursos implantados ao refatorar o código em sua aplicação do CDK.<a name="ref-cli-cmd-commands-synthesize"></a>

 ` synthesize, synth `   
Sintetize um aplicativo CDK para produzir uma montagem na nuvem, incluindo um AWS CloudFormation modelo para cada pilha.<a name="ref-cli-cmd-commands-watch"></a>

 ` watch `   
Observar continuamente um projeto local do CDK em busca de mudanças na realização de implantações e hotswaps.

## Opções globais
<a name="ref-cli-cmd-options"></a>

As opções a seguir são compatíveis com todos os comandos da CLI do CDK.<a name="ref-cli-cmd-options-app"></a>

 `--app, -a <STRING>`   
Fornecer o comando para executar sua aplicação ou diretório do conjunto de nuvem.  
 *Obrigatório*: sim<a name="ref-cli-cmd-options-asset-metadata"></a>

 `--asset-metadata <BOOLEAN>`   
Inclua `aws:asset:*` AWS CloudFormation metadados para recursos que usam ativos.  
 *Obrigatório*: não  
 *Valor padrão*: `true` <a name="ref-cli-cmd-options-build"></a>

 `--build <STRING>`   
Comando para executar uma compilação de pré-síntese.  
 *Obrigatório*: não<a name="ref-cli-cmd-options-ca-bundle-path"></a>

 `--ca-bundle-path <STRING>`   
Caminho para um certificado CA a ser usado ao validar solicitações HTTPS.  
Se essa opção não for fornecida, a CLI do CDK lerá da variável do ambiente `AWS_CA_BUNDLE`.  
 *Obrigatório*: sim<a name="ref-cli-cmd-options-ci"></a>

 `--ci <BOOLEAN>`   
Indicar que os comandos da CLI do CDK estão sendo executados em um ambiente de integração contínua (CI).  
Essa opção modifica o comportamento da CLI do CDK para melhor se adequar às operações automatizadas típicas dos pipelines de CI.  
Quando você fornece essa opção, os logs são enviados para `stdout` em vez de `stderr`.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-context"></a>

 `--context, -c <ARRAY>`   
Adicionar parâmetros de string contextuais como pares chave-valor.<a name="ref-cli-cmd-options-debug"></a>

 `--debug <BOOLEAN>`   
Ativar informações detalhadas de depuração. Essa opção produz uma saída detalhada que inclui muito mais detalhes sobre o que a CLI do CDK está fazendo nos bastidores.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-ec2creds"></a>

 `--ec2creds, -i <BOOLEAN>`   
Forçar a CLI do CDK a tentar obter as credenciais da instância do Amazon EC2.  
Por padrão, a CLI do CDK adivinha o status da instância do Amazon EC2.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-help"></a>

 `--help, -h <BOOLEAN>`   
Mostrar as informações de referência de comando para a CLI do CDK.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-ignore-errors"></a>

 `--ignore-errors <BOOLEAN>`   
Ignorar os erros de síntese, que provavelmente produzirão uma saída inválida.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-json"></a>

 `--json, -j <BOOLEAN>`   
Use JSON em vez de YAML para AWS CloudFormation modelos impressos na saída padrão ()`stdout`.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-lookups"></a>

 `--lookups <BOOLEAN>`   
Realizar pesquisas de contexto.  
A síntese falhará se esse valor for `false` e as pesquisas de contexto precisarem ser realizadas.  
 *Obrigatório*: não  
 *Valor padrão*: `true` <a name="ref-cli-cmd-options-no-color"></a>

 `--no-color <BOOLEAN>`   
Remover a cor e outros estilos da saída do console.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-notices"></a>

 `--notices <BOOLEAN>`   
Mostrar avisos relevantes.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-output"></a>

 `--output, -o <STRING>`   
Especificar o diretório para o qual enviar o conjunto de nuvem sintetizado.  
 *Obrigatório*: sim  
 *Valor padrão*: `cdk.out` <a name="ref-cli-cmd-options-path-metadata"></a>

 `--path-metadata <BOOLEAN>`   
Inclua `aws::cdk::path` AWS CloudFormation metadados para cada recurso.  
 *Obrigatório*: não  
 *Valor padrão*: `true` <a name="ref-cli-cmd-options-plugin"></a>

 `--plugin, -p <ARRAY>`   
Nome ou caminho de um pacote de nó que estende os recursos do CDK. Essa opção pode ser fornecida várias vezes em um único comando.  
É possível configurar essa opção no arquivo `cdk.json` do projeto ou no `~/.cdk.json` em sua máquina de desenvolvimento local:  

```
{
   // ...
   "plugin": [
      "module_1",
      "module_2"
   ],
   // ...
}
```
 *Obrigatório*: não<a name="ref-cli-cmd-options-profile"></a>

 `--profile <STRING>`   
Especifique o nome do AWS perfil, contendo as informações do seu AWS ambiente, para usar com a CLI do CDK.  
 *Obrigatório*: sim<a name="ref-cli-cmd-options-proxy"></a>

 `--proxy <STRING>`   
Usar o proxy indicado.  
Se essa opção não for fornecida, a CLI do CDK lerá da variável do ambiente `HTTPS_PROXY`.  
 *Obrigatório*: sim  
 *Valor padrão*: lido da variável de ambiente `HTTPS_PROXY`.<a name="ref-cli-cmd-options-role-arn"></a>

 `--role-arn, -r <STRING>`   
O ARN da função do IAM que a CLI do CDK assumirá ao interagir. AWS CloudFormation  
 *Obrigatório*: não<a name="ref-cli-cmd-options-staging"></a>

 `--staging <BOOLEAN>`   
Copiar os ativos para o diretório de saída.  
Especificar `false` para evitar a cópia de ativos para o diretório de saída. Isso permite que a CLI do AWS SAM faça referência aos arquivos de origem originais ao realizar a depuração local.  
 *Obrigatório*: não  
 *Valor padrão*: `true` <a name="ref-cli-cmd-options-strict"></a>

 `--strict <BOOLEAN>`   
Não construir pilhas que contenham avisos.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-trace"></a>

 `--trace <BOOLEAN>`   
Imprimir o rastreamento para avisos de pilha.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-verbose"></a>

 `--verbose, -v <COUNT>`   
Mostrar logs de depuração. Especifique essa opção várias vezes para aumentar o detalhamento.  
 *Obrigatório*: não<a name="ref-cli-cmd-options-version"></a>

 `--version <BOOLEAN>`   
Mostrar o número da versão da CLI do CDK.  
 *Obrigatório*: não  
 *Valor padrão*: `false` <a name="ref-cli-cmd-options-version-reporting"></a>

 `--version-reporting <BOOLEAN>`   
Inclua o ` AWS::CDK::Metadata` recurso em modelos sintetizados AWS CloudFormation .  
 *Obrigatório*: não  
 *Valor padrão*: `true` 

## Fornecendo e configurando opções
<a name="ref-cli-cmd-configure"></a>

É possível passar opções por meio de argumentos de linha de comando. Para a maioria das opções, você pode configurá-las em um arquivo de configuração `cdk.json`. Quando você usa várias fontes de configuração, a CLI do CDK segue a precedência a seguir:

1.  **Valores da linha de comando** — Qualquer opção fornecida na linha de comando substitui as opções configuradas nos arquivos `cdk.json`.

1.  **Arquivo de configuração do projeto** — O arquivo `cdk.json` no diretório do seu projeto do CDK.

1.  **Arquivo de configuração do usuário** — O arquivo `cdk.json` localizado em `~/.cdk.json` na sua máquina local.

## Passando opções na linha de comando
<a name="ref-cli-cmd-pass"></a><a name="ref-cli-cmd-pass-bool"></a>

 **Passando valores booleanos**   
Para opções que aceitam um valor booliano, você pode especificá-las destas duas formas:  
+ Usar valores `true` e `false` — Forneça o valor booleano com o comando. Este é um exemplo:

  ```
  $ cdk deploy --watch=true
  $ cdk deploy --watch=false
  ```
+ Fornecer a contrapartida da opção — Modifique o nome da opção adicionando `no` para especificar um valor `false`. Este é um exemplo:

  ```
  $ cdk deploy --watch
  $ cdk deploy --no-watch
  ```
+ Para opções cujo padrão é `true` ou `false`, você não precisa fornecer a opção, a menos que queira mudar do padrão.