Este é o Guia do Desenvolvedor 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á.
Um AWS Cloud Development Kit (AWS CDK) projeto representa os arquivos e pastas que contêm seu código CDK. O conteúdo variará de acordo com sua linguagem de programação.
Você pode criar seu AWS CDK projeto manualmente ou com a interface de linha de AWS CDK comando (AWS CDK CLI) cdk init
comando. Neste tópico, nos referiremos à estrutura do projeto e às convenções de nomenclatura de arquivos e pastas criados pela CLI do AWS CDK. É possível personalizar e organizar seus projetos do CDK para atender às necessidades.
nota
Estrutura do projeto criada pelo AWS CDK CLI pode variar entre as versões ao longo do tempo.
Arquivos e pastas universais
- .git
-
Se você
git
instalou, o AWS CDK CLI inicializa automaticamente um Git repositório para seu projeto. O diretório.git
contém informações sobre o repositório. - .gitignore
-
Arquivo de texto usado por Git para especificar arquivos e pastas a serem ignorados.
- README.md
-
Arquivo de texto que fornece orientações básicas e informações importantes para gerenciar seu AWS CDK projeto. Modifique esse arquivo conforme necessário para documentar informações importantes sobre seu projeto CDK.
- cdk.json
-
Arquivo de configuração para o AWS CDK. Esse arquivo fornece instruções para AWS CDK CLI sobre como executar seu aplicativo.
Arquivos e pastas específicos de linguagem
Os arquivos e pastas a seguir são exclusivos para cada linguagem de programação compatível.
Veja a seguir um exemplo de projeto criado no diretório my-cdk-ts-project
usando o comando cdk init --language typescript
:
my-cdk-ts-project ├── .git ├── .gitignore ├── .npmignore ├── README.md ├── bin │ └── my-cdk-ts-project.ts ├── cdk.json ├── jest.config.js ├── lib │ └── my-cdk-ts-project-stack.ts ├── node_modules ├── package-lock.json ├── package.json ├── test │ └── my-cdk-ts-project.test.ts └── tsconfig.json
- .npmignore
-
Arquivo que especifica quais arquivos e pastas devem ser ignorados ao publicar um pacote no npm registro. Esse arquivo é semelhante a
.gitignore
, mas é específico de npm pacotes. - bin/.ts my-cdk-ts-project
-
O arquivo da aplicação define sua aplicação CDK. Os projetos do CDK contêm um ou mais arquivos de aplicações. Os arquivos da aplicação são armazenados na pasta
bin
.Veja a seguir um exemplo de um arquivo de aplicação básico que define uma aplicação do CDK:
#!/usr/bin/env node import 'source-map-support/register'; import * as cdk from 'aws-cdk-lib'; import { MyCdkTsProjectStack } from '../lib/my-cdk-ts-project-stack'; const app = new cdk.App(); new MyCdkTsProjectStack(app, 'MyCdkTsProjectStack');
- jest.config.js
-
Arquivo de configuração para Jest. Jesté um popular JavaScript estrutura de teste.
- lib/ my-cdk-ts-project -stack.ts
-
O arquivo de pilha define sua pilha de CDK. Na sua pilha, você define os recursos da AWS e as propriedades usando constructos.
Veja a seguir um exemplo de um arquivo de pilha básico que define uma pilha do CDK:
import * as cdk from 'aws-cdk-lib'; import { Construct } from 'constructs'; export class MyCdkTsProjectStack extends cdk.Stack { constructor(scope: Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); // code that defines your resources and properties go here } }
- node_modules
-
Pasta comum em Node.js projetos que contêm dependências para seu projeto.
- package-lock.json
-
Arquivo de metadados que funcionam com o arquivo
package.json
para gerenciar versões de dependências. - package.json
-
Arquivo de metadados que é comumente usado em Node.js projetos. Esse arquivo contém informações sobre seu projeto CDK, como nome do projeto, definições de script, dependências e outras informações de importação em nível de projeto.
- teste/ .test.ts my-cdk-ts-project
-
Uma pasta de teste é criada para organizar os testes do seu projeto CDK. Um arquivo de teste de amostra também é criado.
Você pode escrever testes em TypeScript e use Jest para compilar seu TypeScript codifique antes de executar os testes.
- tsconfig.json
-
Arquivo de configuração usado em TypeScript projetos que especificam as opções do compilador e as configurações do projeto.