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

Trabalhar com o AWS CDK no TypeScript

TypeScript é uma linguagem de cliente totalmente compatível com AWS Cloud Development Kit (AWS CDK) e considerada estável. Trabalhar com o AWS CDK no TypeScript usa ferramentas familiares, incluindo o compilador TypeScript (tsc) da Microsoft, o Node.js e o Node Package Manager (npm). Você também pode usar o Yarn se preferir, embora os exemplos neste Guia usem o NPM. Os módulos que compõem a Biblioteca de Constructos da AWS são distribuídos por meio do repositório NPM, npmjs.org.

Você pode usar qualquer editor ou IDE. Muitos desenvolvedores AWS CDK usam o Visual Studio Code (ou seu equivalente de código aberto VSCodium), que tem excelente suporte para TypeScript.

Conceitos básicos de TypeScript

Para trabalhar com AWS CDK, você deve ter uma conta e credenciais da AWS e ter instalado o Node.js e o Toolkit AWS CDK. Consulte Conceitos básicos da AWS CDK.

Você também precisa do próprio TypeScript (versão 3.8 ou posterior). Se ainda não tiver, poderá instalá-lo usando npm.

npm install -g typescript

Mantenha o TypeScript atualizado com npm update -g typescript normal.

Criação de um projeto

Você cria um novo projeto do AWS CDK invocando cdk init em um diretório vazio. Use a opção --language e especifique typescript:

mkdir my-project
cd my-project
cdk init app --language typescript

A criação de um projeto também instala o módulo aws-cdk-lib e suas dependências.

cdk init usa o nome da pasta do projeto para nomear vários elementos do projeto, incluindo classes, subpastas e arquivos. Hifens no nome da pasta são convertidos em sublinhados. No entanto, o nome deve seguir a forma de um identificador do TypeScript; por exemplo, não deve começar com um número nem conter espaços.

Uso de tsc e cdk local

Na maioria das vezes, este guia pressupõe que você instale o TypeScript e o CDK Toolkit globalmente (npm install -g typescript aws-cdk), e os exemplos de comandos fornecidos (como cdk synth) seguem essa suposição. Essa abordagem facilita a atualização dos dois componentes e, como ambos adotam uma abordagem rígida de compatibilidade com versões anteriores, geralmente há pouco risco em sempre usar as versões mais recentes.

Algumas equipes preferem especificar todas as dependências em cada projeto, incluindo ferramentas como o compilador TypeScript e o CDK Toolkit. Essa prática permite que você fixe esses componentes em versões específicas e garanta que todos os desenvolvedores da sua equipe (e do seu ambiente de CI/CD) usem exatamente essas versões. Isso elimina uma possível fonte de mudança, ajudando a tornar as compilações e implantações mais consistentes e reproduzíveis.

O CDK inclui dependências tanto para o TypeScript quanto para o CDK Toolkit em package.json do modelo de projeto do TypeScript. Portanto, se você quiser usar essa abordagem, não precisará fazer nenhuma alteração em seu projeto. Tudo o que você precisa fazer é usar comandos ligeiramente diferentes para criar seu aplicativo e emitir comandos cdk.

npx aws-cdk executa a versão do CDK Toolkit instalada localmente no projeto atual, se houver, retornando à instalação global, se houver. Se não existir uma instalação global, npx baixa uma cópia temporária do CDK Toolkit e a executa. Você pode especificar uma versão arbitrária do CDK Toolkit usando a sintaxe @: npx aws-cdk@2.0 --version imprime 2.0.0.

Gerenciamento de módulos da Biblioteca de Constructos da AWS

Use o Node Package Manager (npm) para instalar e atualizar os módulos da Biblioteca de Constructos da AWS para uso por seus aplicativos, bem como por outros pacotes necessários. (Você pode usar yarn em vez de npm, se preferir.) npm também instala as dependências desses módulos automaticamente.

A maioria dos constructos AWS CDK está no pacote CDK principal, chamado aws-cdk-lib, que é uma dependência padrão em novos projetos criados por cdk init. Os módulos “experimentais” da Biblioteca de Constructos da AWS, nos quais constructos de nível superior ainda estão em desenvolvimento, são nomeados como @aws-cdk/SERVICE-NAME-alpha. O nome do serviço tem um prefixo aws-. Se você não tiver certeza do nome de um módulo, procure-o no NPM.

Por exemplo, o comando abaixo instala o módulo experimental para AWS CodeStar.

npm install @aws-cdk/aws-codestar-alpha

O suporte da Biblioteca de Constructos de alguns serviços está em mais de um namespace. Por exemplo, além de aws-route53, há três namespaces adicionais do Amazon Route 53, aws-route53-targets, aws-route53-patterns e aws-route53resolver.

As dependências do seu projeto são mantidas em package.json. Você pode editar esse arquivo para bloquear algumas ou todas as suas dependências em uma versão específica ou para permitir que elas sejam atualizadas para versões mais recentes sob determinados critérios. Para atualizar as dependências do NPM do seu projeto para a versão mais recente permitida de acordo com as regras que você especificou em package.json:

npm update

No TypeScript, você importa módulos para o seu código com o mesmo nome usado para instalá-los usando o NPM. Recomendamos as seguintes práticas ao importar AWS CDK classes e módulos da Biblioteca de Constructos da AWS em seus aplicativos. Seguir essas diretrizes ajudará a tornar seu código consistente com outros aplicativos AWS CDK, além de ser mais fácil de entender.

Gerenciamento de dependências em TypeScript

Em projetos CDK TypeScript, as dependências são especificadas no arquivo package.json, no diretório principal do projeto. Os módulos AWS CDK principais estão em um único pacote NPM chamado aws-cdk-lib.

Quando você instala um pacote usando npm install, o NPM grava o pacote em package.json para você.

Se preferir, você pode usar o Yarn no lugar do NPM. No entanto, o CDK não suporta o modo plug-and-play do Yarn, que é o modo padrão no Yarn 2. Adicione o seguinte ao arquivo .yarnrc.yml do seu projeto para desativar esse atributo.

nodeLinker: node-modules

Aplicações do CDK

Veja a seguir um exemplo de arquivo package.json gerado pelo comando cdk init --language typescript:

{
  "name": "my-package",
  "version": "0.1.0",
  "bin": {
    "my-package": "bin/my-package.js"
  },
  "scripts": {
    "build": "tsc",
    "watch": "tsc -w",
    "test": "jest",
    "cdk": "cdk"
  },
  "devDependencies": {
    "@types/jest": "^26.0.10",
    "@types/node": "10.17.27",
    "jest": "^26.4.2",
    "ts-jest": "^26.2.0",
    "aws-cdk": "2.16.0",
    "ts-node": "^9.0.0",
    "typescript": "~3.9.7"
  },
  "dependencies": {
    "aws-cdk-lib": "2.16.0",
    "constructs": "^10.0.0",
    "source-map-support": "^0.5.16"
  }
}

Para aplicativos CDK implantáveis, aws-cdk-lib deve ser especificado na seção dependencies de package.json. Você pode usar um especificador de número de versão com acento circunflexo (^) para indicar que aceitará versões posteriores à especificada, desde que estejam na mesma versão principal.

Para constructos experimentais, especifique as versões exatas dos módulos da Biblioteca de Constructos alfa, que têm APIs que podem mudar. Não use ^ ou ~, pois versões posteriores desses módulos podem trazer alterações na API que podem prejudicar seu aplicativo.

Especifique as versões das bibliotecas e ferramentas necessárias para testar seu aplicativo (por exemplo, a estrutura de teste jest) na seção devDependencies de package.json. Opcionalmente, use ^ para especificar que versões compatíveis posteriores sejam aceitáveis.

Bibliotecas de compilação de terceiros

Se você estiver desenvolvendo uma biblioteca de construção, especifique suas dependências usando uma combinação das seções peerDependencies e devDependencies, conforme mostrado no arquivo package.json de exemplo a seguir.

{
  "name": "my-package",
  "version": "0.0.1",
  "peerDependencies": {
    "aws-cdk-lib": "^2.14.0",
    "@aws-cdk/aws-appsync-alpha": "2.10.0-alpha",
    "constructs": "^10.0.0"
  },
  "devDependencies": {
    "aws-cdk-lib": "2.14.0",
    "@aws-cdk/aws-appsync-alpha": "2.10.0-alpha",
    "constructs": "10.0.0",
    "jsii": "^1.50.0",
    "aws-cdk": "^2.14.0"
  }
}

Em peerDependencies, use um acento circunflexo (^) para especificar a versão mais baixa de aws-cdk-lib com a qual sua biblioteca trabalha. Isso maximiza a compatibilidade da sua biblioteca com uma variedade de versões do CDK. Especifique as versões exatas dos módulos de Biblioteca de Constructos alfa, que têm APIs que podem mudar. O uso de peerDependencies garante que haja apenas uma cópia de todas as bibliotecas CDK na árvore node_modules.

Em devDependencies, especifique as ferramentas e bibliotecas que você precisa para testar, opcionalmente com ^ para indicar que versões compatíveis posteriores são aceitáveis. Especifique exatamente (sem ^ ou ~) as versões mais baixas de aws-cdk-lib e outros pacotes de CDK com os quais você anuncia a compatibilidade da sua biblioteca. Essa prática garante que seus testes sejam executados nessas versões. Dessa forma, se você usar inadvertidamente um atributo encontrado apenas em versões mais recentes, seus testes poderão detectá-lo.

Instalação e atualização de dependências

Use o seguinte comando para instalar as dependências.

NPM

# Install the latest version of everything that matches the ranges in 'package.json'
npm install

# Install the same exact dependency versions as recorded in 'package-lock.json'
npm ci

Yarn

# Install the latest version of everything that matches the ranges in 'package.json'
yarn upgrade

# Install the same exact dependency versions as recorded in 'yarn.lock'
yarn install --frozen-lockfile

Para atualizar os módulos instalados, os comandos npm install e yarn upgrade anteriores podem ser usados. Qualquer um dos comandos atualiza os pacotes em node_modules para as versões mais recentes que atendem às regras em package.json. No entanto, não atualizam package.json por conta própria, o que talvez você queira fazer para definir uma nova versão mínima. Se você hospedar seu pacote no GitHub, poderá configurar as atualizações de versão do Dependabot para atualizar package.json automaticamente. Como alternativa, use npm-check-updates.

AWS CDK expressões idiomáticas em TypeScript

Props

Todas as classes da Biblioteca de Constructos da AWS são instanciadas usando três argumentos: o escopo no qual o constructo está sendo definido (seu pai na árvore de constructos), um id e adereços. O argumento props consiste em um pacote de pares de chave/valor que o constructo usa para configurar os recursos AWS que ele cria. Outras classes e métodos também usam o padrão “pacote de atributos” para argumentos.

No TypeScript, a forma de props é definida usando uma interface que informa os argumentos obrigatórios e opcionais e seus tipos. Essa interface é definida para cada tipo de argumento props, geralmente específico para um único constructo ou método. Por exemplo, o constructo Bucket (em aws-cdk-lib/aws-s3 module) especifica um argumento props em conformidade com a interface BucketProps.

Se uma propriedade for em si um objeto, por exemplo, a propriedade websiteRedirect de BucketProps, esse objeto terá sua própria interface à qual sua forma deverá estar em conformidade, nesse caso, RedirectTarget.

Se estiver subclassificando uma classe da Biblioteca de Constructos da AWS (ou substituindo um método que usa um argumento semelhante a adereços), você pode herdar da interface existente para criar uma nova que especifique quaisquer novos adereços que seu código exija. Ao chamar a classe principal ou o método base, você normalmente pode passar todo o argumento props recebido, pois quaisquer atributos fornecidos no objeto, mas não especificados na interface, serão ignorados.

Uma versão futura de AWS CDK poderia coincidentemente adicionar uma nova propriedade com um nome que você usou para sua própria propriedade. Passar o valor que você recebe para a cadeia de herança pode causar um comportamento inesperado. É mais seguro passar uma cópia rasa dos adereços que você recebeu com sua propriedade removida ou configurada para undefined. Por exemplo:

super(scope, name, {...props, encryptionKeys: undefined});

Como alternativa, nomeie suas propriedades para que fique claro que elas pertencem ao seu constructo. Dessa forma, é improvável que colidam com propriedades em versões AWS CDK futuras. Se houver muitas delas, use um único objeto com nome apropriado para mantê-las.

Valores ausentes

Valores ausentes em um objeto (como props) têm o valor undefined em TypeScript. A versão 3.7 da linguagem introduziu operadores que simplificam o trabalho com esses valores, facilitando a especificação de padrões e o encadeamento em “curto-circuito” quando um valor indefinido é atingido. Para obter mais informações sobre esses atributos, consulte as Notas de versão do TypeScript 3.7, especificamente os dois primeiros recursos, encadeamento opcional e coalescência nula.

Compilação e execução de aplicativos do CDK

Normalmente, você deve estar no diretório raiz do projeto ao criar e executar seu aplicativo.

O Node.js não pode executar o TypeScript diretamente; em vez disso, seu aplicativo é convertido em JavaScript usando o compilador TypeScript, tsc. Em seguida, o código JavaScript resultante é executado.

AWS CDK faz isso automaticamente sempre que precisa executar seu aplicativo. No entanto, pode ser útil compilar manualmente para verificar erros e executar testes. Para compilar seu aplicativo TypeScript manualmente, emita npm run build. Você também pode emitir npm run watch para entrar no modo de observação, no qual o compilador TypeScript reconstrói automaticamente seu aplicativo sempre que você salva as alterações em um arquivo de origem.