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

Implemente AWS CDK aplicativos

Uma AWS Cloud Development Kit (AWS CDK) implantação é o processo de provisionamento de sua infraestrutura. AWS

Como as AWS CDK implantações funcionam

Ele AWS CDK utiliza o AWS CloudFormation serviço para realizar implantações. Antes de implantar, você sintetiza suas CDK pilhas. Isso cria um CloudFormation modelo e artefatos de implantação para cada CDK pilha no seu aplicativo. As implantações são iniciadas a partir de uma máquina de desenvolvimento local ou a partir de um ambiente de integração e entrega contínuas (CI/CD). Durante a implantação, os ativos são enviados para os recursos inicializados e o CloudFormation modelo é enviado para CloudFormation provisionar seus recursos. AWS

Para que uma implantação seja bem-sucedida, é necessário o seguinte:

Pré-requisitos para implantações CDK

Antes de implantar um AWS CDK aplicativo, você deve concluir o seguinte:

Configurar credenciais de segurança

Para usar a CDK CLI para interagir AWS, você deve configurar as credenciais de segurança em sua máquina local. Para obter instruções, consulte Configurar as credenciais de segurança para o AWS CDK CLI.

Inicialize seu ambiente AWS

Uma implantação está sempre associada a um ou mais AWS ambientes. Antes de implantar, o ambiente deve primeiro receber o bootstrapping. O bootstrapping provisiona recursos em seu ambiente que ele CDK usa para realizar e gerenciar implantações. Esses recursos incluem um bucket do Amazon Simple Storage Service (Amazon S3) e um repositório Amazon Elastic Container Registry (ECRAmazon) para armazenar e gerenciar ativos. Esses recursos também incluem AWS Identity and Access Management (IAM) funções que são usadas para fornecer permissões durante o desenvolvimento e a implantação.

Recomendamos que você use a interface de linha de AWS CDK comando (AWS CDK CLI) cdk bootstrap comando para inicializar seu ambiente. Você pode personalizar o bootstrapping ou criar manualmente esses recursos em seu ambiente, se necessário. Para obter instruções, consulte Inicialize seu ambiente para uso com o AWS CDK.

Configurar AWS ambientes

Cada CDK pilha deve estar associada a um ambiente para determinar onde a pilha é implantada. Para obter instruções, consulte Configurar ambientes para usar com o AWS CDK.

Desenvolva seu CDK aplicativo

Em um CDK projeto, você cria e desenvolve seu CDK aplicativo. No seu aplicativo, você cria uma ou mais CDK pilhas. Em suas pilhas, você importa e usa construções da AWS Construct Library para definir sua infraestrutura. Antes de implantar, seu CDK aplicativo deve conter pelo menos uma pilha.

CDKsíntese de aplicativos

Para realizar a síntese, recomendamos que você use o CDK CLI comando cdk synth. O comando cdk deploy também realizará a síntese antes de iniciar a implantação. No entanto, usandocdk synth, você pode validar seu CDK aplicativo e detectar erros antes de iniciar a implantação.

O comportamento da síntese é determinado pelo sintetizador de pilha que você configura para sua pilha. CDK Se você não configurar um sintetizador, DefaultStackSynthesizer será usado. Você também pode configurar e personalizar a síntese para atender às suas necessidades. Para obter instruções, consulte Configurar e realizar a síntese de pilhas do CDK.

Para que seu CloudFormation modelo sintetizado seja implantado com êxito em seu ambiente, ele deve ser compatível com a forma como seu ambiente foi inicializado. Por exemplo, seu CloudFormation modelo deve especificar o bucket correto do Amazon S3 no qual implantar ativos. Se você usar o método padrão de inicializar seu ambiente, o sintetizador de pilha padrão funcionará. Se você personalizar o CDK comportamento, como personalizar a inicialização ou a síntese, o comportamento da CDK implantação poderá variar.

O ciclo de vida da aplicação

Quando você realiza a síntese, seu CDK aplicativo passa pelas seguintes fases, conhecidas como ciclo de vida do aplicativo:

Executar sua aplicação

A CDK CLI precisa saber como executar seu CDK aplicativo. Se você criou o projeto a partir de um modelo usando o comando cdk init, o arquivo cdk.json da sua aplicação inclui uma chave app. Essa chave especifica o comando necessário para a linguagem em que a aplicação está escrita. Se sua linguagem exigir compilação, a linha de comando executará essa etapa antes de executar a aplicação automaticamente.

TypeScript

{
  "app": "npx ts-node --prefer-ts-exts bin/my-app.ts"
}

JavaScript

{
  "app": "node bin/my-app.js"
}

Python

{
    "app": "python app.py"
}

Java

{
  "app": "mvn -e -q compile exec:java"
}

C#

{
  "app": "dotnet run -p src/MyApp/MyApp.csproj"
}

Go

{
  "app": "go mod download && go run my-app.go"
}

Se você não criou seu projeto usando o CDK CLI, ou se quiser substituir a linha de comando fornecida emcdk.json, você pode fornecer a --app opção ao executar o cdk comando.

$ cdk --app 'executable' cdk-command ...

A executable parte do comando indica o comando que deve ser executado para executar seu CDK aplicativo. Use aspas conforme mostrado, pois esses comandos contêm espaços. O cdk-command é um subcomando como synth ou deploy que informa o CDK CLI o que você quer fazer com seu aplicativo. Siga isso com todas as opções adicionais necessárias para esse subcomando.

A CDK CLI também pode interagir diretamente com um conjunto de nuvem já sintetizado. Para fazer isso, passe o diretório no qual o conjunto de nuvem está armazenado em --app. O exemplo a seguir lista as pilhas definidas no conjunto de nuvem armazenado em ./my-cloud-assembly.

$ cdk --app ./my-cloud-assembly ls

Conjuntos de nuvem

A chamada para app.synth() é o que diz AWS CDK para sintetizar uma montagem em nuvem a partir de um aplicativo. Normalmente, você não interage diretamente com os conjuntos de nuvem. São arquivos que incluem tudo o que é necessário para implantar sua aplicação em um ambiente de nuvem. Por exemplo, ele inclui um AWS CloudFormation modelo para cada pilha em seu aplicativo. Também inclui uma cópia de qualquer ativo de arquivo ou Docker imagens que você faz referência no seu aplicativo.

Consulte a especificação de conjunto de nuvem para detalhes sobre como os conjuntos de nuvem são formatados.

Para interagir com o conjunto de nuvem que seu AWS CDK aplicativo cria, você normalmente usa o AWS CDK CLI. No entanto, qualquer ferramenta que possa ler o formato de montagem em nuvem pode ser usada para implantar seu aplicativo.

Implantar a aplicação

Para implantar seu aplicativo, recomendamos que você use o CDK CLI cdk deploycomando para iniciar implantações ou configurar implantações automatizadas.

Quando você correcdk deploy, o CDK CLI inicia a preparação cdk synth para a implantação. O diagrama a seguir ilustra o ciclo de vida da aplicação no contexto de uma implantação:

Durante a implantação, o CDK CLI pega a montagem da nuvem produzida pela síntese e a implanta em um AWS ambiente. Os ativos são enviados para o Amazon S3 e para a Amazon ECR e o CloudFormation modelo é enviado AWS CloudFormation para implantação.

Quando a fase de AWS CloudFormation implantação começa, seu CDK aplicativo já terminou de ser executado e foi encerrado. Isso ocasiona o seguinte:

Permissões de implantação

Antes da execução da implantação, as permissões devem ser estabelecidas. O diagrama a seguir ilustra as permissões que são usadas durante uma implantação padrão, ao usar o processo de bootstrapping padrão e o sintetizador de pilha: