Uso Comandos Opções globais Fornecendo e configurando opções Passando opções na linha de comando

Referência de comandos da CLI do AWS CDK

Esta seção contém informações de referência para a interface de linha de comandos (CLI) do kit de desenvolvimento em nuvem da AWS (CDK da AWS). A CLI do CDK também é conhecida como Kit de Ferramentas CDK.

Uso


$ cdk <command> <arguments> <options>

Comandos

acknowledge ack: Reconheça um aviso pelo número do problema e oculte-o de ser exibido novamente.

bootstrap: Prepare um ambiente da AWS para implantações do CDK implantando a pilha de bootstrapping do CDK, chamada CDKToolkit, no ambiente da AWS.

context: Gerenciar valores de contexto em cache para sua aplicação CDK.

deploy: Implantar uma ou mais pilhas CDK em seu ambiente AWS.

destroy: Excluir uma ou mais pilhas CDK do seu ambiente AWS.

diff: Fazer uma comparação para ver as mudanças na infraestrutura entre as pilhas CDK.

docs doc: Abrir a documentação CDK no seu navegador.

doctor: Inspecionar e exibir informações úteis sobre seu projeto do CDK local e ambiente de desenvolvimento.

drift: Detecte o desvio de configuração dos recursos que você define, gerencia e implanta usando o CDK.

flags: Visualize e modifique suas configurações de sinalizadores de atributos para a CLI do CDK.

import: Use as importações de recursos do AWS CloudFormation para importar recursos da AWS existentes em uma pilha do CDK.

init: Criar um novo projeto do CDK a partir de um modelo.

list, ls: Listar todas as pilhas CDK e suas dependências em uma aplicação CDK.

metadata: Exibir metadados associados a uma pilha do CDK.

migrate: Migre os recursos da AWS, pilhas do AWS CloudFormation e modelos do AWS CloudFormation para um novo projeto do CDK.

notices: Exibir avisos para sua aplicação CDK.

refactor: Preserve os recursos implantados ao refatorar o código em sua aplicação do CDK.

synthesize, synth: Sintetize uma aplicação do CDK para produzir um conjunto de nuvem, incluindo um modelo do AWS CloudFormation para cada pilha.

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

Opções globais

As opções a seguir são compatíveis com todos os comandos da CLI do CDK.

--app, -a <STRING>

Fornecer o comando para executar sua aplicação ou diretório do conjunto de nuvem.

Obrigatório: Sim

--asset-metadata <BOOLEAN>

Incluir metadados aws:asset:* do AWS CloudFormation para recursos que usam ativos.

Obrigatório: não

Valor padrão: true

--build <STRING>

Comando para executar uma compilação de pré-síntese.

Obrigatório: não

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

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

--context, -c <ARRAY>: Adicionar parâmetros de string contextuais como pares chave-valor.

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

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

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

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

--json, -j <BOOLEAN>

Usar JSON em vez de YAML para modelos do AWS CloudFormation impressos na saída padrão (stdout).

Obrigatório: não

Valor padrão: false

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

--no-color <BOOLEAN>

Remover a cor e outros estilos da saída do console.

Obrigatório: não

Valor padrão: false

--notices <BOOLEAN>

Mostrar avisos relevantes.

Obrigatório: não

Valor padrão: false

--output, -o <STRING>

Especificar o diretório para o qual enviar o conjunto de nuvem sintetizado.

Obrigatório: Sim

Valor padrão: cdk.out

--path-metadata <BOOLEAN>

Incluir os metadados aws::cdk::path do AWS CloudFormation para cada recurso.

Obrigatório: não

Valor padrão: true

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

--profile <STRING>

Especifique o nome do perfil AWS, contendo as informações do seu ambiente da AWS, para usar com a CLI do CDK.

Obrigatório: Sim

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

--role-arn, -r <STRING>

O ARN do perfil do IAM que a CLI do CDK assumirá ao interagir com o AWS CloudFormation.

Obrigatório: não

--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 à CLI do AWS SAM referenciar os arquivos de origem originais ao realizar a depuração local.

Obrigatório: não

Valor padrão: true

--strict <BOOLEAN>

Não construir pilhas que contenham avisos.

Obrigatório: não

Valor padrão: false

--trace <BOOLEAN>

Imprimir o rastreamento para avisos de pilha.

Obrigatório: não

Valor padrão: false

--verbose, -v <COUNT>

Mostrar logs de depuração. Especifique essa opção várias vezes para aumentar o detalhamento.

Obrigatório: não

--version <BOOLEAN>

Mostrar o número da versão da CLI do CDK.

Obrigatório: não

Valor padrão: false

--version-reporting <BOOLEAN>

Incluir o recurso AWS::CDK::Metadata em modelos sintetizados do AWS CloudFormation.

Obrigatório: não

Valor padrão: true

Fornecendo e configurando opções

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

Valores da linha de comando — Qualquer opção fornecida na linha de comando substitui as opções configuradas nos arquivos cdk.json.
Arquivo de configuração do projeto — O arquivo cdk.json no diretório do seu projeto do CDK.
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

Passando valores boolianos

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. Veja um exemplo a seguir:
```
$ 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. Veja um exemplo a seguir:
```
$ 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.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Referência da CLI do AWS CDK

cdk ack