Este é o Guia do Desenvolvedor AWS CDK v2. A versão CDK 1 mais antiga 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 CDKCLIReferência de comando
Esta seção contém informações de referência de comando para a interface de linha de AWS Cloud Development Kit (AWS CDK) comando (CLI). O CDK também CLI é conhecido como CDK Toolkit.
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 AWS ambiente para implantações de CDK implantando a pilha de bootstrap CDK, chamada, no ambiente.
CDKToolkit
AWS context
-
Gerencie valores de contexto em cache para seu aplicativo CDK.
deploy
-
Implante uma ou mais pilhas de CDK em seu AWS ambiente.
destroy
-
Exclua uma ou mais pilhas de CDK do seu AWS ambiente.
diff
-
Faça uma comparação para ver as mudanças na infraestrutura entre as pilhas de CDK.
docs, doc
-
Abra a documentação do CDK em seu navegador.
doctor
-
Inspecione e exiba informações úteis sobre seu projeto CDK local e ambiente de desenvolvimento.
import
-
Use importações AWS CloudFormation de recursos para importar AWS recursos existentes em uma pilha de CDK.
init
-
Crie um novo projeto CDK a partir de um modelo.
list, ls
-
Liste todas as pilhas de CDK e suas dependências em um aplicativo CDK.
metadata
-
Exibir metadados associados a uma pilha de CDK.
migrate
-
Migre AWS recursos, AWS CloudFormation pilhas e AWS CloudFormation modelos para um novo projeto CDK.
notices
-
Exiba avisos para seu aplicativo CDK.
synthesize, synth
-
Sintetize um aplicativo CDK para produzir uma montagem na nuvem, incluindo um AWS CloudFormation modelo para cada pilha.
watch
-
Observe continuamente um projeto local de 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 CLI comandos do CDK.
--app, -a
STRING
-
Forneça o comando para executar seu aplicativo ou diretório de montagem em nuvem.
Obrigatório: Sim
--asset-metadata
BOOLEAN
-
Inclua
aws:asset:*
AWS CloudFormation metadados 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, o CDK CLI lerá a variável de
AWS_CA_BUNDLE
ambiente.Obrigatório: Sim
--ci
BOOLEAN
-
Indique que CLI os comandos do CDK estão sendo executados em um ambiente de integração contínua (CI).
Essa opção modifica o comportamento do CDK CLI para melhor se adequar às operações automatizadas típicas dos pipelines de CI.
Quando você fornece essa opção, os registros são enviados para
stdout
em vez destderr
.Obrigatório: não
Valor padrão:
false
--context, -c
ARRAY
-
Adicione parâmetros de string contextuais como pares de valores-chave.
--debug
BOOLEAN
-
Ative informações detalhadas de depuração. Essa opção produz uma saída detalhada que inclui muito mais detalhes sobre o que o CDK CLI está fazendo nos bastidores.
Obrigatório: não
Valor padrão:
false
--ec2creds, -i
BOOLEAN
-
Force o CDK CLI a tentar obter as credenciais da instância do Amazon EC2.
Por padrão, o CDK CLI adivinha o status da instância do Amazon EC2.
Obrigatório: não
Valor padrão:
false
--help, -h
BOOLEAN
-
Mostra as informações de referência do comando para o CDK. CLI
Obrigatório: não
Valor padrão:
false
--ignore-errors
BOOLEAN
-
Ignore 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
-
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
--lookups
BOOLEAN
-
Faça 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
-
Remova a cor e outros estilos da saída do console.
Obrigatório: não
Valor padrão:
false
--notices
BOOLEAN
-
Mostre avisos relevantes.
Obrigatório: não
Valor padrão:
false
--output, -o
STRING
-
Especifique o diretório para o qual enviar o conjunto de nuvem sintetizado.
Obrigatório: Sim
Valor padrão:
cdk.out
--path-metadata
BOOLEAN
-
Inclua
aws::cdk::path
AWS CloudFormation metadados para cada recurso.Obrigatório: não
Valor padrão:
true
--plugin, -p
ARRAY
-
Nome ou caminho de um node pacote que estende os recursos do CDK. Essa opção pode ser fornecida várias vezes em um único comando.
Você pode configurar essa opção no
cdk.json
arquivo do projeto ou~/.cdk.json
em sua máquina de desenvolvimento local:{ // ... "plugin": [ "module_1", "module_2" ], // ... }
Obrigatório: não
--profile
STRING
-
Especifique o nome do AWS perfil, contendo as informações do seu AWS ambiente, para usar com o CDKCLI.
Obrigatório: Sim
--proxy
STRING
-
Use o proxy indicado.
Se essa opção não for fornecida, o CDK CLI lerá a variável de
HTTPS_PROXY
ambiente.Obrigatório: Sim
Valor padrão: lido da variável de
HTTPS_PROXY
ambiente. --role-arn, -r
STRING
-
O ARN da função do IAM que o CDK CLI assumirá ao interagir com. AWS CloudFormation
Obrigatório: não
--staging
BOOLEAN
-
Copie os ativos para o diretório de saída.
Especifique
false
para evitar a cópia de ativos no diretório de saída. Isso permite AWS SAM CLI referenciar os arquivos de origem originais ao realizar a depuração local.Obrigatório: não
Valor padrão:
true
--strict
BOOLEAN
-
Não construa pilhas que contenham avisos.
Obrigatório: não
Valor padrão:
false
--trace
BOOLEAN
-
Imprima o rastreamento para avisos de pilha.
Obrigatório: não
Valor padrão:
false
--verbose, -v
COUNT
-
Mostrar registros de depuração. Você pode especificar essa opção várias vezes para aumentar a verbosidade.
Obrigatório: não
--version
BOOLEAN
-
Mostre o número da CLI versão do CDK.
Obrigatório: não
Valor padrão:
false
--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
Você pode passar opções por meio de argumentos de linha de comando. Para a maioria das opções, você pode configurá-las em um arquivo cdk.json
de configuração. Quando você usa várias fontes de configuração, o CDK CLI segue a seguinte precedência:
-
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
cdk.json
arquivo no diretório do seu projeto CDK. -
Arquivo de configuração do usuário — O
cdk.json
arquivo localizado~/.cdk.json
em sua máquina local.
Passando opções na linha de comando
Passando valores booleanos
Para opções que aceitam um valor booleano, você pode especificá-las das seguintes formas:
-
Uso
true
efalse
valores — Forneça o valor booleano com o comando. Veja um exemplo a seguir:$
cdk deploy --watch=true
$
cdk deploy --watch=false
-
Forneça a contrapartida da opção — Modifique o nome da opção adicionando
no
para especificar umfalse
valor. Veja um exemplo a seguir:$
cdk deploy --watch
$
cdk deploy --no-watch
-
Para opções cujo padrão é
true
oufalse
, você não precisa fornecer a opção, a menos que queira mudar do padrão.