Este é o Guia do Desenvolvedor AWS CDK v2. A CDK v1 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 CDK CLI referência
A interface de linha de AWS Cloud Development Kit (AWS CDK) comando (AWS CDK CLI), também conhecido como CDK Toolkit, é a principal ferramenta para interagir com seu AWS CDK aplicativo. Ele executa seu aplicativo, interroga o modelo de aplicativo que você definiu e produz e implanta os AWS CloudFormation modelos gerados pelo. AWS CDK Ele também fornece outros recursos úteis para criar e trabalhar com AWS CDK projetos. Este tópico contém informações sobre casos de uso comuns do CDK CLI.
A CDK CLI é instalado com o Node Package Manager. Na maioria dos casos, recomendamos instalá-lo globalmente.
npm install -g aws-cdk # install latest version npm install -g aws-cdk@X.YY.Z # install specific version
dica
Se você trabalha regularmente com várias versões do AWS CDK, considere instalar uma versão correspondente do CDK CLI em CDK projetos individuais. Para fazer isso, omita -g
do comando npm install
. Em seguida, use npx aws-cdk
para invocá-lo. Isso executa a versão local, se houver, voltando para uma versão global, se não existir.
CDK CLI Comandos da do
Todas as CDK CLI os comandos começam comcdk
, que é seguido por um subcomando (list
,, synthesize
deploy
, etc.). Alguns subcomandos têm uma versão mais curta (ls
, synth
, etc.) que é equivalente. As opções e os argumentos seguem o subcomando em qualquer ordem.
Para uma descrição de todos os subcomandos, opções e argumentos, consulte AWS CDK CLI Referência de comando.
Especificar as opções e seus valores
As opções da linha de comandos começam com dois hífens (--
). Algumas opções usadas com frequência têm sinônimos de uma única letra que começam com um único hífen (por exemplo, --app
tem um sinônimo -a
). A ordem das opções em um CDK CLI o comando não é importante.
Todas as opções aceitam um valor, que deve seguir o nome da opção. O valor pode ser separado do nome por espaço em branco ou por um sinal de igual =
. As duas opções a seguir são equivalentes.
--toolkit-stack-name MyBootstrapStack --toolkit-stack-name=MyBootstrapStack
Algumas opções são sinalizadores (booleanos). Você pode especificar true
ou false
como seu valor. Se você não fornecer um valor, ele será considerado como true
. Você também pode prefixar o nome da opção com um prefixo no-
para sugerir false
.
# sets staging flag to true --staging --staging=true --staging true # sets staging flag to false --no-staging --staging=false --staging false
Algumas opções, a saber, --context
, --parameters
, --plugin
, --tags
e --trust
, podem ser especificadas mais de uma vez para especificar vários valores. Eles são anotados como tendo o [array]
tipo no CDK CLI socorro. Por exemplo:
cdk bootstrap --tags costCenter=0123 --tags responsibleParty=jdoe
Ajuda integrada
A CDK CLI tem ajuda integrada. Você pode ver a ajuda geral sobre o utilitário e uma lista dos subcomandos fornecidos emitindo:
cdk --help
Para ver a ajuda de um subcomando específico, por exemplo, deploy
, especifique-o antes do sinalizador --help
.
cdk deploy --help
Problema cdk version
para exibir a versão do CDK CLI. Forneça essas informações ao solicitar suporte.
Relatórios de versão
Para obter informações sobre como o AWS CDK é usado, as construções usadas pelos AWS CDK aplicativos são coletadas e relatadas usando um recurso identificado comoAWS::CDK::Metadata
. Esse recurso é adicionado aos AWS CloudFormation modelos e pode ser facilmente revisado. Essas informações também podem ser usadas AWS para identificar pilhas usando uma construção com problemas conhecidos de segurança ou confiabilidade. Também pode ser usado para contatar seus usuários com informações importantes.
nota
Antes da versão 1.93.0, eles AWS CDK relatavam os nomes e versões dos módulos carregados durante a síntese, em vez das construções usadas na pilha.
Por padrão, ele AWS CDK relata o uso de construções nos seguintes NPM módulos que são usados na pilha:
-
AWS CDK módulo principal
-
AWS Construir módulos de biblioteca
-
AWS Módulo Solutions Constructs
-
AWS Módulo do kit de implantação do Render Farm
O recurso AWS::CDK::Metadata
é parecido com o mostrado a seguir.
CDKMetadata: Type: "AWS::CDK::Metadata" Properties: Analytics: "v2:deflate64:H4sIAND9SGAAAzXKSw5AMBAA0L1b2PdzBYnEAdio3RglglY60zQi7u6TWL/XKmNUlxeQSOKwaPTBqrNhwEWU3hGHiCzK0dWWfAxoL/Fd8mvk+QkS/0X6BdjnCdgmOOQKWz+AqqLDt2Y3YMnLYWwAAAA="
A propriedade Analytics
é uma lista compactada com gzip, codificada em base64 e codificada por prefixo dos constructos na pilha.
Recusar geração de relatórios de versão
Você pode optar por não receber relatórios de versão usando o CDK CLI ou configurando o cdk.json
arquivo do seu projeto.
Para optar por não receber relatórios de versão usando o CDK CLI
-
Use a
--no-version-reporting
opção com qualquer CDK CLI comando para optar por não receber um único comando. Este é um exemplo de recusa durante a síntese do modelo:$
cdk synth --no-version-reporting
Como ele AWS CDK sintetiza modelos automaticamente quando você executa
cdk deploy
, você também deve usar--no-version-reporting
com ocdk deploy
comando.
Para optar por não receber relatórios de versão configurando o arquivo cdk.json
-
Defina
versionReporting
comofalse
em./cdk.json
ou~/.cdk.json
. Isso exclui você por padrão. Veja um exemplo a seguir:{ "app": "...", "versionReporting": false }
Após a configuração, você pode substituir esse comportamento e optar por participar especificando
--version-reporting
em um comando individual.
nota
Quando você opta por não receber relatórios de versão, eles não AWS CDK coletarão nem reportarão dados sobre quais construções você está usando. Por causa disso, eles não AWS CDK conseguirão identificar se você foi afetado por problemas de segurança e não enviarão notificações sobre eles.
Autenticação com AWS
Há diferentes maneiras de configurar o acesso programático aos AWS recursos, dependendo do ambiente e do AWS acesso disponível para você.
Para escolher seu método de autenticação e configurá-lo para o CDK CLI, consulte Configurar as credenciais de segurança para o AWS CDK CLI.
A abordagem recomendada para novos usuários que se desenvolvem localmente, que não recebem um método de autenticação por parte do empregador, é configurar AWS IAM Identity Center. Esse método inclui a instalação do AWS CLI para facilitar a configuração e entrar regularmente no portal de AWS acesso. Se você escolher esse método, seu ambiente deverá conter os seguintes elementos depois de concluir o procedimento de autenticação do IAM Identity Center no Guia de Referência de Ferramentas AWS SDKs e Ferramentas:
-
O AWS CLI, que você usa para iniciar uma sessão do portal de AWS acesso antes de executar seu aplicativo.
-
Um arquivo
config
da AWS compartilhado com um perfil de[default]
com um conjunto de valores de configuração que podem ser referenciados a partir do AWS CDK. Para encontrar a localização desse arquivo, consulte Localização dos arquivos compartilhados no Guia de referência de ferramentas AWS SDKs e ferramentas. -
O arquivo
config
compartilhado define a configuração doregion
. Isso define o padrão Região da AWS de AWS CDK e. CDK CLI use para AWS solicitações. -
A CDK CLI usa a configuração do provedor de SSO token do perfil para adquirir credenciais antes de enviar solicitações para o. AWS O
sso_role_name
valor, que é uma IAM função conectada a um conjunto de permissões do IAM Identity Center, deve permitir o acesso ao Serviços da AWS usado em seu aplicativo.O
config
arquivo de exemplo a seguir mostra um perfil padrão configurado com a configuração SSO do provedor de token. A configuraçãosso_session
do perfil se refere à seção dosso-session
. Asso-session
seção contém configurações para iniciar uma sessão do portal de AWS acesso.[default] sso_session =
my-sso
sso_account_id =111122223333
sso_role_name =SampleRole
region =us-east-1
output = json [sso-sessionmy-sso
] sso_region =us-east-1
sso_start_url =https://provided-domain.awsapps.com/start
sso_registration_scopes = sso:account:access
Iniciar uma sessão do portal de AWS acesso
Antes de acessar Serviços da AWS, você precisa de uma sessão ativa do portal de AWS acesso para o CDK CLI para usar a autenticação do IAM Identity Center para resolver as credenciais. Dependendo da duração da sessão configurada, seu acesso acabará expirando e o CDK CLI encontrará um erro de autenticação. Execute o seguinte comando no AWS CLI para entrar no portal de AWS acesso.
aws sso login
Se a configuração do seu provedor de SSO token estiver usando um perfil nomeado em vez do perfil padrão, o comando seráaws sso login --profile
. Especifique também esse perfil ao emitir comandos cdk usando a opção --profile ou a variável de ambiente NAME
AWS_PROFILE
.
Para testar se você já tem uma sessão ativa, execute o AWS CLI comando a seguir.
aws sts get-caller-identity
A resposta a esse comando deve relatar a conta e o conjunto de permissões do IAM Identity Center configurados no config
arquivo compartilhado.
nota
Se você já tiver uma sessão ativa do portal de AWS acesso e executá-laaws sso login
, não será necessário fornecer credenciais.
O processo de login pode solicitar que você permita o AWS CLI acesso aos seus dados. Como o AWS CLI é construído em cima do SDK for Python, as mensagens de permissão podem conter variações do botocore
nome.
Especificar região e outra configuração
A CDK CLI precisa saber em qual AWS região você está implantando e como se autenticar. AWS Isso é necessário para operações de implantação e para recuperar valores de contexto durante a síntese. Juntas, sua conta e sua região compõem o ambiente.
A região pode ser especificada usando variáveis de ambiente ou em arquivos de configuração. Essas são as mesmas variáveis e arquivos usados por outras AWS ferramentas, como a AWS CLI e as várias AWS SDKs. A CDK CLI procura essas informações na seguinte ordem.
-
A variável de ambiente
AWS_DEFAULT_REGION
. -
Um perfil nomeado definido no AWS
config
arquivo padrão e especificado usando a--profile
opção noscdk
comandos. -
A
[default]
seção do AWSconfig
arquivo padrão.
Além de especificar a AWS autenticação e uma região na [default]
seção, você também pode adicionar uma ou mais [profile
seções, onde NAME
]NAME
está o nome do perfil. Para obter mais informações sobre perfis nomeados, consulte Arquivos de configuração e credenciais compartilhados no Guia de referência de ferramentas AWS SDKs e ferramentas.
O AWS config
arquivo padrão está localizado em ~/.aws/config
(macOS/Linux) ou %USERPROFILE%\.aws\config
(Windows). Para obter detalhes e localizações alternativas, consulte Localização dos arquivos compartilhados de configuração e credenciais no Guia de referência de ferramentas AWS SDKs e ferramentas
O ambiente que você especifica no seu AWS CDK aplicativo usando a env
propriedade da pilha é usado durante a síntese. Ele é usado para gerar um AWS CloudFormation modelo específico do ambiente e, durante a implantação, substitui a conta ou a região especificada por um dos métodos anteriores. Para obter mais informações, consulte Ambientes para o AWS CDK.
nota
O AWS CDK usa credenciais dos mesmos arquivos de origem de outras AWS ferramentas eSDKs, incluindo o. AWS Command Line Interface No entanto, eles AWS CDK podem se comportar de forma um pouco diferente dessas ferramentas. Ele usa a parte de AWS SDK for JavaScript baixo do capô. Para obter detalhes completos sobre a configuração de credenciais para o AWS SDK for JavaScript, consulte Configuração de credenciais.
Opcionalmente, você pode usar a opção --role-arn
(ou-r
) para especificar uma IAM função que deve ser usada para implantação. ARN Essa função deve ser assumida pela AWS conta que está sendo usada.
Especificar o comando da aplicação
Muitas características do CDK CLI exigem que um ou mais AWS CloudFormation modelos sejam sintetizados, o que, por sua vez, requer a execução do aplicativo. O AWS CDK suporta programas escritos em vários idiomas. Portanto, ele usa uma opção de configuração para especificar o comando exato necessário para executar sua aplicação. Essa opção pode ser especificada de duas formas.
Primeiro, e mais comumente, ele pode ser especificado usando a chave app
dentro do arquivo cdk.json
. Isso está no diretório principal do seu AWS CDK projeto. A CDK CLI fornece um comando apropriado ao criar um novo projeto comcdk init
. Aqui está o cdk.json
de um novo TypeScript projeto, por exemplo.
{ "app": "npx ts-node bin/hello-cdk.ts" }
A CDK CLI procura cdk.json
no diretório de trabalho atual ao tentar executar seu aplicativo. Por causa disso, você pode manter um shell aberto no diretório principal do seu projeto para emissão CDK CLI comandos.
A CDK CLI também procura a chave do aplicativo ~/.cdk.json
(ou seja, no seu diretório inicial) se não conseguir encontrá-la./cdk.json
. Adicionar o comando do aplicativo aqui pode ser útil se você costuma trabalhar com CDK código no mesmo idioma.
Se você estiver em algum outro diretório ou quiser executar sua aplicação usando um comando diferente daquele em cdk.json
, use a opção --app
(ou -a
) para especificá-lo.
cdk --app "npx ts-node bin/hello-cdk.ts" ls
Ao implantar, você também pode especificar um diretório contendo conjuntos de nuvem sintetizados, como cdk.out
, com o valor de --app. As pilhas especificadas são implantadas a partir desse diretório. A aplicação não é sintetizada.
Especificar pilhas
Muitos CDK CLI comandos (por exemplo,cdk deploy
) funcionam em pilhas definidas no seu aplicativo. Se seu aplicativo contiver apenas uma pilha, o CDK CLI presume que você se refere a essa se não especificar uma pilha explicitamente.
Caso contrário, você deverá especificar a pilha ou pilhas com as quais deseja trabalhar. Você pode fazer isso especificando as pilhas desejadas por ID individualmente na linha de comando. Lembre-se de que o ID é o valor especificado pelo segundo argumento quando você instancia a pilha.
cdk synth PipelineStack LambdaStack
Você também pode usar curingas para especificar IDs que correspondem a um padrão.
-
?
corresponde a qualquer caractere único -
*
corresponde a qualquer número de caracteres (*
sozinho corresponde a todas as pilhas) -
**
corresponde a tudo em uma hierarquia
Você também pode usar a opção --all para especificar todas as pilhas.
Se seu aplicativo usa CDKPipelines, o CDK CLI entende suas pilhas e estágios como uma hierarquia. Além disso, a opção --all e o curinga *
correspondem apenas às pilhas de nível superior. Para combinar todas as pilhas, use **
. Use também **
para indicar todas as pilhas em uma determinada hierarquia.
Ao usar curingas, coloque o padrão entre aspas ou escape dos curingas com \
. Caso contrário, seu shell pode tentar expandir o padrão para os nomes dos arquivos no diretório atual. Na melhor das hipóteses, não acontecerá o que você espera; na pior das hipóteses, você pode implantar pilhas que não pretendia. Isso não é estritamente necessário no Windows porque cmd.exe
não expande os curingas, mas ainda assim é uma boa prática.
cdk synth "*Stack" # PipelineStack, LambdaStack, etc. cdk synth 'Stack?' # StackA, StackB, Stack1, etc. cdk synth \* # All stacks in the app, or all top-level stacks in a CDK Pipelines app cdk synth '**' # All stacks in a CDK Pipelines app cdk synth 'PipelineStack/Prod/**' # All stacks in Prod stage in a CDK Pipelines app
nota
A ordem na qual você especifica as pilhas não é necessariamente a ordem na qual elas serão processadas. A CDK CLI considera as dependências entre as pilhas ao decidir a ordem na qual processá-las. Por exemplo, digamos que uma pilha usa um valor produzido por outra (como o ARN de um recurso definido na segunda pilha). Nesse caso, a segunda pilha é sintetizada antes da primeira devido a essa dependência. Você pode adicionar dependências entre as pilhas manualmente usando o método addDependency()
da pilha.
Inicialize seu ambiente AWS
A implantação de pilhas com o CDK exige que AWS CDK recursos especiais dedicados sejam provisionados. O comando cdk
bootstrap
cria os recursos necessários para você. Você só precisa fazer o bootstrapping se estiver implantando uma pilha que exija esses recursos dedicados. Para mais detalhes, consulte Bootstrapping do AWS CDK.
cdk bootstrap
Se emitido sem argumentos, conforme mostrado aqui, o comando cdk bootstrap
sintetiza a aplicação atual e inicializa os ambientes nos quais suas pilhas serão implantadas. Se a aplicação contiver pilhas independentes do ambiente, que não especificam explicitamente um ambiente, será feito o bootstrapping na conta e na região padrão, ou o ambiente especificado será usando --profile
.
Fora de uma aplicação, você deve especificar explicitamente o ambiente a ser inicializado. Você também pode fazer isso para inicializar um ambiente que não esteja especificado em seu aplicativo ou AWS perfil local. As credenciais devem ser configuradas (por exemplo, em ~/.aws/credentials
) para a conta e a região especificadas. Você pode especificar um perfil que contenha as credenciais necessárias.
cdk bootstrap
ACCOUNT-NUMBER
/REGION
# e.g. cdk bootstrap 1111111111/us-east-1 cdk bootstrap --profile test 1111111111/us-east-1
Importante
O bootstrapping de cada ambiente (combinação de conta/região) no qual você implanta essa pilha deve ser feito separadamente.
Você pode incorrer em AWS cobranças pelo que eles AWS CDK armazenam nos recursos inicializados. Além disso, se você usar-bootstrap-customer-key
, uma AWS KMS chave será criada, o que também incorrerá em cobranças por ambiente.
nota
As versões anteriores do modelo de bootstrap criavam uma KMS chave por padrão. Para evitar cobranças, faça o bootstrapping novamente usando --no-bootstrap-customer-key
.
nota
CDK CLI A v2 não suporta o modelo de bootstrap original, apelidado de modelo legado, usado por padrão com a v1. CDK
Importante
O modelo de bootstrap moderno concede efetivamente as permissões implícitas no --cloudformation-execution-policies
para qualquer AWS conta na --trust
lista. Por padrão, isso estende as permissões de leitura e gravação em qualquer recurso na conta inicializada. Certifique-se de configurar a pilha de inicialização com políticas e contas confiáveis com as quais você se sinta confortável.
Criar um nova aplicação
Para criar um nova aplicação, crie um diretório para ele e, dentro do diretório, emita cdk init
.
mkdir my-cdk-app cd my-cdk-app cdk init
TEMPLATE
--languageLANGUAGE
Os idiomas suportados (LANGUAGE
) são:
Código |
Idioma |
---|---|
|
TypeScript |
|
JavaScript |
|
Python |
|
Java |
|
C# |
TEMPLATE
é um modelo opcional. Se o modelo desejado for app, o padrão, você poderá omiti-lo. Os modelos disponíveis são:
Modelo |
Descrição |
---|---|
|
Cria um AWS CDK aplicativo vazio. |
|
Cria um AWS CDK aplicativo com uma pilha contendo uma SQS fila da Amazon e um tópico da AmazonSNS. |
Os modelos usam o nome da pasta do projeto para gerar nomes para arquivos e classes dentro do sua nova aplicação.
Listar pilhas
Para ver uma lista IDs das pilhas em seu AWS CDK aplicativo, insira um dos seguintes comandos equivalentes:
cdk list cdk ls
Se seu aplicativo contiver pilhas de CDKPipelines, o CDK CLI exibe os nomes das pilhas como caminhos de acordo com sua localização na hierarquia do pipeline. (Por exemplo, PipelineStack
, PipelineStack/Prod
e PipelineStack/Prod/MyService
.)
Se seu aplicativo contiver muitas pilhas, você poderá especificar a pilha total ou parcial IDs das pilhas a serem listadas. Para obter mais informações, consulte Especificar pilhas.
Adicione a --long
bandeira para ver mais informações sobre as pilhas, incluindo os nomes das pilhas e seus ambientes (AWS conta e região).
Sintetizar pilhas
O cdk synthesize
comando (quase sempre abreviadosynth
) sintetiza uma pilha definida no seu aplicativo em um modelo. CloudFormation
cdk synth # if app contains only one stack cdk synth MyStack cdk synth Stack1 Stack2 cdk synth "*" # all stacks in app
nota
A CDK CLI na verdade, executa seu aplicativo e sintetiza novos modelos antes da maioria das operações (como ao implantar ou comparar pilhas). Esses modelos são armazenados por padrão no diretório cdk.out
. O comando cdk synth
simplesmente imprime os modelos gerados em uma ou mais pilhas especificadas.
Consulte cdk synth --help
para obter todas as opções disponíveis. Algumas das opções usadas com mais frequência são abordadas na seção a seguir.
Especificar valores do contexto
Use a -c
opção --context
ou para passar valores de contexto de tempo de execução para seu CDK aplicativo.
# specify a single context value cdk synth --context key=value MyStack # specify multiple context values (any number) cdk synth --context key1=value1 --context key2=value2 MyStack
Ao implantar várias pilhas, os valores de contexto especificados normalmente são passados para todas elas. Se quiser, você pode especificar valores diferentes para cada pilha prefixando o nome da pilha no valor do contexto.
# different context values for each stack cdk synth --context Stack1:key=value Stack2:key=value Stack1 Stack2
Especificar o formato de exibição
Por padrão, o modelo sintetizado é exibido em YAML formato. Em vez disso, adicione a --json
bandeira para exibi-la no JSON formato.
cdk synth --json MyStack
Especificar o diretório de saída
Adicione a opção --output
(-o
) para gravar os modelos sintetizados em um diretório diferente de cdk.out
.
cdk synth --output=~/templates
Implantar pilhas
O cdk deploy
subcomando implanta uma ou mais pilhas especificadas em sua conta. AWS
cdk deploy # if app contains only one stack cdk deploy MyStack cdk deploy Stack1 Stack2 cdk deploy "*" # all stacks in app
nota
A CDK CLI executa seu aplicativo e sintetiza novos AWS CloudFormation modelos antes de implantar qualquer coisa. Portanto, a maioria das opções de linha de comando que você pode usar com cdk synth
(por exemplo, --context
) também pode ser usada com cdk deploy
.
Consulte cdk deploy --help
para obter todas as opções disponíveis. Algumas das opções mais úteis são abordadas na seção a seguir.
Ignorar síntese
O comando cdk deploy normalmente sintetiza as pilhas da sua aplicação antes da implantação para garantir que a implantação reflita a versão mais recente da sua aplicação. Se você sabe que não alterou seu código desde o último cdk synth, você pode suprimir a etapa de síntese redundante durante a implantação. Para fazer isso, especifique o diretório cdk.out
do seu projeto na opção --app.
cdk deploy --app cdk.out StackOne StackTwo
Desabilitar reversão
AWS CloudFormation tem a capacidade de reverter as alterações para que as implantações sejam atômicas. Isso significa que eles são bem-sucedidos ou falham como um todo. O AWS CDK herda esse recurso porque sintetiza e implanta modelos. AWS CloudFormation
A reversão garante que seus recursos estejam sempre em um estado consistente, o que é vital para as pilhas de produção. No entanto, enquanto você ainda está desenvolvendo sua infraestrutura, algumas falhas são inevitáveis, e reverter implantações malsucedidas pode atrasar o processo.
Por esse motivo, o CDK CLI permite que você desative a reversão adicionando --no-rollback
ao seu cdk deploy
comando. Com esse sinalizador, implantações com falha não são revertidas. Em vez disso, os recursos implantados antes do recurso com falha permanecem em vigor e a próxima implantação começa com o recurso com falha. Você passará muito menos tempo esperando por implantações e muito mais tempo desenvolvendo sua infraestrutura.
Troca dinâmica
Use o --hotswap
sinalizador with cdk deploy
para tentar atualizar seus AWS recursos diretamente em vez de gerar um conjunto de AWS CloudFormation alterações e implantá-lo. A implantação volta à AWS CloudFormation implantação se a troca dinâmica não for possível.
Atualmente, o hot swapping suporta funções Lambda, máquinas de estado Step Functions e imagens de contêineres da Amazon. ECS O sinalizador --hotswap
também desabilita a reversão (ou seja, implica em --no-rollback
).
Importante
A troca dinâmica não é recomendada para implantações de produção.
Modo de observação
A CDK CLIO modo de observação (cdk deploy --watchou cdk watch abreviadamente) monitora continuamente os arquivos de origem e os ativos do seu CDK aplicativo em busca de alterações. Ele executa imediatamente uma implantação das pilhas especificadas quando uma alteração é detectada.
Por padrão, essas implantações usam a o sinalizador --hotswap
, que acelera a implantação de alterações nas funções do Lambda. Ele também volta à implantação AWS CloudFormation se você tiver alterado a configuração da infraestrutura. Para cdk watch
sempre realizar AWS CloudFormation implantações completas, adicione o --no-hotswap
sinalizador a. cdk watch
Todas as alterações feitas enquanto cdk watch
já está executando uma implantação são combinadas em uma única implantação, que começa assim que a implantação em andamento é concluída.
O modo de observação usa a chave "watch"
no cdk.json
do projeto para determinar quais arquivos monitorar. Por padrão, esses arquivos são os arquivos e ativos da sua aplicação, mas isso pode ser alterado modificando as entradas "include"
e "exclude"
na chave "watch"
. O arquivo cdk.json
a seguir mostra um exemplo dessas entradas.
{ "app": "mvn -e -q compile exec:java", "watch": { "include": "src/main/**", "exclude": "target/*" } }
cdk watch
executa o comando "build"
do cdk.json
para criar sua aplicação antes da síntese. Se sua implantação exigir algum comando para criar ou empacotar seu código Lambda (ou qualquer outra coisa que não esteja em seu CDK aplicativo), adicione-o aqui.
Os curingas no estilo Git, tanto *
quanto **
, podem ser usados nas chaves "watch"
e "build"
. Cada caminho é interpretado em relação ao diretório principal do cdk.json
. O valor padrão de include
é **/*
, ou seja, todos os arquivos e diretórios no diretório raiz do projeto. exclude
é opcional.
Importante
O modo de observação não é recomendado para implantações de produção.
Especifique AWS CloudFormation os parâmetros
A CDK CLI suporta a especificação de AWS CloudFormation parâmetros na implantação. Você pode fornecê-los na linha de comando seguindo o sinalizador --parameters
.
cdk deploy MyStack --parameters uploadBucketName=UploadBucket
Para definir vários parâmetros, use vários sinalizadores --parameters
.
cdk deploy MyStack --parameters uploadBucketName=UpBucket --parameters downloadBucketName=DownBucket
Se você estiver implantando várias pilhas, poderá especificar um valor diferente de cada parâmetro para cada pilha. Para fazer isso, prefixe o nome do parâmetro com o nome da pilha e dois pontos. Caso contrário, o mesmo valor será passado para todas as pilhas.
cdk deploy MyStack YourStack --parameters MyStack:uploadBucketName=UploadBucket --parameters YourStack:uploadBucketName=UpBucket
Por padrão, o AWS CDK retém os valores dos parâmetros de implantações anteriores e os usa em implantações posteriores, caso não sejam especificados explicitamente. Use o sinalizador --no-previous-parameters
para exigir que todos os parâmetros sejam especificados.
Especificar arquivo de saídas
Se sua pilha declarar AWS CloudFormation saídas, elas normalmente são exibidas na tela no final da implantação. Para gravá-los em um arquivo em JSON formato, use a --outputs-file
bandeira.
cdk deploy --outputs-file outputs.json MyStack
Aprovar alterações relacionadas à segurança
Para protegê-lo contra alterações não intencionais que afetam sua postura de segurança, o CDK CLI solicita que você aprove as alterações relacionadas à segurança antes de implantá-las. Você pode especificar o nível de alteração que requer aprovação:
cdk deploy --require-approval
LEVEL
LEVEL
pode ser um dos seguintes:
Prazo |
Significado |
---|---|
|
A aprovação nunca é necessária |
|
Requer aprovação de qualquer security-group-related alteração IAM ou alteração |
|
Requer aprovação quando IAM declarações ou regras de trânsito são adicionadas; remoções não exigem aprovação |
A configuração também pode ser definida no arquivo cdk.json
.
{ "app": "...", "requireApproval": "never" }
Comparar pilhas
O cdk diff
comando compara a versão atual de uma pilha (e suas dependências) definida em seu aplicativo com as versões já implantadas ou com um AWS CloudFormation modelo salvo e exibe uma lista de alterações.
Stack HelloCdkStack IAM Statement Changes ┌───┬──────────────────────────────┬────────┬──────────────────────────────┬──────────────────────────────┬───────────┐ │ │ Resource │ Effect │ Action │ Principal │ Condition │ ├───┼──────────────────────────────┼────────┼──────────────────────────────┼──────────────────────────────┼───────────┤ │ + │ ${Custom::S3AutoDeleteObject │ Allow │ sts:AssumeRole │ Service:lambda.amazonaws.com │ │ │ │ sCustomResourceProvider/Role │ │ │ │ │ │ │ .Arn} │ │ │ │ │ ├───┼──────────────────────────────┼────────┼──────────────────────────────┼──────────────────────────────┼───────────┤ │ + │ ${MyFirstBucket.Arn} │ Allow │ s3:DeleteObject* │ AWS:${Custom::S3AutoDeleteOb │ │ │ │ ${MyFirstBucket.Arn}/* │ │ s3:GetBucket* │ jectsCustomResourceProvider/ │ │ │ │ │ │ s3:GetObject* │ Role.Arn} │ │ │ │ │ │ s3:List* │ │ │ └───┴──────────────────────────────┴────────┴──────────────────────────────┴──────────────────────────────┴───────────┘ IAM Policy Changes ┌───┬────────────────────────────────────────────────────────┬────────────────────────────────────────────────────────┐ │ │ Resource │ Managed Policy ARN │ ├───┼────────────────────────────────────────────────────────┼────────────────────────────────────────────────────────┤ │ + │ ${Custom::S3AutoDeleteObjectsCustomResourceProvider/Ro │ {"Fn::Sub":"arn:${AWS::Partition}:iam::aws:policy/serv │ │ │ le} │ ice-role/AWSLambdaBasicExecutionRole"} │ └───┴────────────────────────────────────────────────────────┴────────────────────────────────────────────────────────┘ (NOTE: There may be security-related changes not in this list. See https://github.com/aws/aws-cdk/issues/1299) Parameters [+] Parameter AssetParameters/4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392/S3Bucket AssetParameters4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392S3BucketBF7A7F3F: {"Type":"String","Description":"S3 bucket for asset \"4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392\""} [+] Parameter AssetParameters/4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392/S3VersionKey AssetParameters4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392S3VersionKeyFAF93626: {"Type":"String","Description":"S3 key for asset version \"4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392\""} [+] Parameter AssetParameters/4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392/ArtifactHash AssetParameters4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392ArtifactHashE56CD69A: {"Type":"String","Description":"Artifact hash for asset \"4cd61014b71160e8c66fe167e43710d5ba068b80b134e9bd84508cf9238b2392\""} Resources [+] AWS::S3::BucketPolicy MyFirstBucket/Policy MyFirstBucketPolicy3243DEFD [+] Custom::S3AutoDeleteObjects MyFirstBucket/AutoDeleteObjectsCustomResource MyFirstBucketAutoDeleteObjectsCustomResourceC52FCF6E [+] AWS::IAM::Role Custom::S3AutoDeleteObjectsCustomResourceProvider/Role CustomS3AutoDeleteObjectsCustomResourceProviderRole3B1BD092 [+] AWS::Lambda::Function Custom::S3AutoDeleteObjectsCustomResourceProvider/Handler CustomS3AutoDeleteObjectsCustomResourceProviderHandler9D90184F [~] AWS::S3::Bucket MyFirstBucket MyFirstBucketB8884501 ├─ [~] DeletionPolicy │ ├─ [-] Retain │ └─ [+] Delete └─ [~] UpdateReplacePolicy ├─ [-] Retain └─ [+] Delete
Para comparar as pilhas da sua aplicação com a implantação existente:
cdk diff MyStack
Para comparar as pilhas do seu aplicativo com um CloudFormation modelo salvo:
cdk diff --template ~/stacks/MyStack.old MyStack
Importar recursos existentes para uma pilha
Você pode usar o cdk import
comando para colocar os recursos sob o gerenciamento CloudFormation de uma AWS CDK pilha específica. Isso é útil se você estiver migrando ou movendo recursos entre pilhas ou alterando sua identificação lógica. cdk import
Usa importações de CloudFormation recursos. AWS CDK Veja a lista de recursos que podem ser importados aqui.
Para importar um recurso existente em uma AWS CDK pilha, siga as seguintes etapas:
-
Verifique se o recurso não está sendo gerenciado atualmente por nenhuma outra CloudFormation pilha. Se estiver, primeiro defina a política de remoção como
RemovalPolicy.RETAIN
para a pilha em que o recurso está atualmente e execute uma implantação. Em seguida, remova o recurso da pilha e execute outra implantação. Esse processo garantirá que o recurso não seja mais gerenciado CloudFormation , mas não o exclua. -
Execute a
cdk diff
para garantir que não haja alterações pendentes na AWS CDK pilha para a qual você deseja importar recursos. As únicas alterações permitidas em uma operação de “importação” são a adição de novos recursos que você deseja importar. -
Adicione constructos para os recursos que você deseja importar para a pilha. Por exemplo, se você quiser importar um bucket do Amazon S3, adicione algo como
new s3.Bucket(this, 'ImportedS3Bucket', {});
. Não faça nenhuma modificação em nenhum outro recurso.Você também deve se certificar de modelar exatamente o estado que o recurso tem atualmente na definição. Para o exemplo do bucket, não se esqueça de incluir AWS KMS chaves, políticas de ciclo de vida e qualquer outra coisa que seja relevante sobre o bucket. Se você não o fizer, as operações de atualização subsequentes podem não fazer o que você espera.
Você pode escolher se deseja ou não incluir o nome do bucket físico. Geralmente, recomendamos não incluir nomes de recursos em suas definições de AWS CDK recursos para que seja mais fácil implantar seus recursos várias vezes.
-
Executar
cdk import
.STACKNAME
-
Se os nomes dos recursos não estiverem em seu modelo, CLI ele solicitará que você informe os nomes reais dos recursos que você está importando. Depois disso, a importação é iniciada.
-
Quando
cdk import
relata o sucesso, o recurso agora é gerenciado por AWS CDK CloudFormation e. Qualquer alteração subsequente que você fizer nas propriedades do recurso em seu AWS CDK aplicativo, a configuração de construção será aplicada na próxima implantação. -
Para confirmar se a definição do recurso no seu AWS CDK aplicativo corresponde ao estado atual do recurso, você pode iniciar uma operação de detecção de CloudFormation desvios.
Atualmente, esse atributo não oferece suporte à importação de recursos para pilhas aninhadas.
Configuração (cdk.json
)
Valores padrão para muitos CDK CLI sinalizadores de linha de comando podem ser armazenados no cdk.json
arquivo de um projeto ou no .cdk.json
arquivo do seu diretório de usuário. A seguir, é apresentada uma referência alfabética às configurações compatíveis.
Chave | Observações | CDK CLI option |
---|---|---|
app |
O comando que executa o CDK aplicativo. | --app |
assetMetadata |
Sefalse , CDK não adiciona metadados aos recursos que usam ativos. |
--no-asset-metadata |
bootstrapKmsKeyId |
Substitui o ID da AWS KMS chave usada para criptografar o bucket de implantação do Amazon S3. | --bootstrap-kms-key-id |
build |
O comando que compila ou constrói o CDK aplicativo antes da síntese. Não é permitido no ~/.cdk.json . |
--build |
browser |
O comando para iniciar um navegador da Web para o subcomando cdk docs . |
--browser |
context |
Consulte Valores de contexto e o AWS CDK. Os valores de contexto em um arquivo de configuração não serão apagados pelo cdk
context --clear. (O CDK CLI coloca valores de contexto em cache emcdk.context.json .) |
--context |
debug |
Setrue , CDK CLI emite informações mais detalhadas úteis para depuração. |
--debug |
language |
A linguagem a ser usada para inicializar novos projetos. | --language |
lookups |
Se for false , nenhuma pesquisa de contexto será permitida. A síntese falhará se alguma pesquisa de contexto precisar ser realizada. |
--no-lookups |
notices |
Se for false , suprime a exibição de mensagens sobre vulnerabilidades de segurança, regressões e versões sem suporte. |
--no-notices |
output |
O nome do diretório no qual o conjunto de nuvem sintetizado será emitido ("cdk.out" padrão). |
--output |
outputsFile |
O arquivo no qual as AWS CloudFormation saídas das pilhas implantadas serão gravadas (em JSON formato). | --outputs-file |
pathMetadata |
Sefalse , os metadados do CDK caminho não forem adicionados aos modelos sintetizados. |
--no-path-metadata |
plugin |
JSONmatriz especificando os nomes dos pacotes ou os caminhos locais dos pacotes que estendem o CDK | --plugin |
profile |
Nome do AWS perfil padrão usado para especificar as credenciais da região e da conta. | --profile |
progress |
Se definido como"events" , o CDK CLI exibe todos os AWS CloudFormation eventos durante a implantação, em vez de uma barra de progresso. |
--progress |
requireApproval |
Nível de aprovação padrão para alterações de segurança. Consulte Aprovar alterações relacionadas à segurança | --require-approval |
rollback |
Se for false , as implantações com falha não serão revertidas. |
--no-rollback |
staging |
Sefalse , os ativos não forem copiados para o diretório de saída (use para depuração local dos arquivos de origem com). AWS SAM |
--no-staging |
tags |
JSONobjeto contendo tags (pares de valores-chave) para a pilha. | --tags |
toolkitBucketName |
O nome do bucket do Amazon S3 usado para implantar ativos como funções do Lambda e imagens de contêiner (consulte Inicialize seu ambiente AWS). | --toolkit-bucket-name |
toolkitStackName |
O nome da ação da pilha de bootstrap (consulte Inicialize seu ambiente AWS). | --toolkit-stack-name |
versionReporting |
Se for false , opta por não receber relatórios de versão. |
--no-version-reporting |
watch |
JSONobjeto contendo "include" "exclude" chaves que indicam quais arquivos devem (ou não) acionar uma reconstrução do projeto quando alterados. Consulte Modo de observação. |
--watch |