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

Aplicativos do AWS CDK

O aplicativo ou app do AWS Cloud Development Kit (AWS CDK) é uma coleção de uma ou mais pilhas do CDK. As pilhas são uma coleção de um ou mais constructos que definem os recursos e propriedades da AWS. Portanto, o agrupamento geral de suas pilhas e constructos é conhecido como seu aplicativo do CDK.

Como criar um aplicativo do CDK

Você cria um aplicativo definindo uma instância do aplicativo no arquivo do seu projeto. Para fazer isso, você importa e usa o constructo do App da Biblioteca de Constructos da AWS. O constructo do App não requer nenhum argumento de inicialização. É o único constructo que pode ser usado como raiz.

As classes App e Stack da Biblioteca de Constructos AWS são constructos exclusivos. Em comparação com outros constructos, eles não configuram recursos da AWS sozinhas. Em vez disso, eles são usados para fornecer contexto para seus outros constructos. Todos os constructos que representam recursos da AWS devem ser definidos, direta ou indiretamente, dentro do escopo de um constructo da Stack. Os constructos da Stack são definidos dentro do escopo do constructo de um App.

Os aplicativos são então sintetizados para criar modelos do AWS CloudFormation para suas pilhas. Veja um exemplo a seguir:

TypeScript

const app = new App();
new MyFirstStack(app, 'hello-cdk');
app.synth();

JavaScript

const app = new App();
new MyFirstStack(app, 'hello-cdk');
app.synth();

Python

app = App()
MyFirstStack(app, "hello-cdk")
app.synth()

Java

App app = new App();
new MyFirstStack(app, "hello-cdk");
app.synth();

C#

var app = new App();
new MyFirstStack(app, "hello-cdk");
app.Synth();

Go

app := awscdk.NewApp(nil)
            
MyFirstStack(app, "MyFirstStack", &MyFirstStackProps{
  awscdk.StackProps{
    Env: env(),
  },
})

app.Synth(nil)

As pilhas em um único aplicativo podem se referir facilmente aos recursos e propriedades umas das outras. O AWS CDK infere dependências entre as pilhas para que elas possam ser implantadas na ordem correta. Você pode implantar qualquer uma ou todas as pilhas em um aplicativo com um único comando cdk deploy.

A árvore de constructos

Os constructos são definidos dentro de outros constructos usando o argumento scope que é passado para cada constructo, com a classe App como raiz. Dessa forma, um aplicativo do AWS CDK define uma hierarquia de constructos, conhecida como árvore de constructos.

A raiz dessa árvore é seu aplicativo, que é uma instância da classe App. Dentro do aplicativo, você instancia uma ou mais pilhas. Nas pilhas, você instancia constructos, podendo eles mesmos instanciar recursos ou outros constructos, e assim por diante na árvore.

Os constructos são sempre definidos explicitamente dentro do escopo de outro constructo, o que cria relações entre os constructos. Quase sempre, você deve passar this (no Python, self) como escopo, indicando que o novo constructo é secundário do constructo atual. O padrão pretendido é que você derive seu constructo de Construct e, em seguida, instancie os constructos que ele usa em seu construtor.

Passar o escopo explicitamente permite que cada constructo se adicione à árvore, com esse comportamento inteiramente contido na classe de base do Construct. Funciona da mesma forma em todos as linguagens compatíveis com o AWS CDK e não requer personalização adicional.

O AWS CDK usa os IDs de todos os constructos no caminho da raiz da árvore até cada constructo secundário para gerar os IDs exclusivos exigidos pelo AWS CloudFormation. Essa abordagem significa que os IDs de constructo só precisam ser exclusivos em seu escopo, e não em toda a pilha, como no AWS CloudFormation nativo. No entanto, se você mover um constructo para um escopo diferente, o ID exclusivo da pilha gerada será alterado e o AWS CloudFormation não o considerará como o mesmo recurso.

A árvore de constructos é separada dos constructo que você define no seu código do AWS CDK. No entanto, é acessível por meio de qualquer atributo node do constructo, que é uma referência ao nó que representa esse constructo na árvore. Cada nó é uma instância de Node, cujos atributos fornecem acesso à raiz da árvore e aos escopos principais e secundários do nó.

A árvore de constructos define uma ordem implícita na qual os constructos são sintetizados em recursos no modelo final do AWS CloudFormation. Onde um recurso deve ser criado antes do outro, o AWS CloudFormation ou a Biblioteca de Constructos da AWS geralmente infere a dependência. Em seguida, eles garantem que os recursos sejam criados na ordem correta.

Você também pode adicionar uma dependência explícita entre dois nós usando node.addDependency(). Para obter mais informações, consulte Dependências na Referência de APIs do AWS CDK.

O AWS CDK fornece uma maneira simples de visitar todos os nós na árvore de constructos e realizar uma operação em cada um. Para ter mais informações, consulte Aspectos e o AWS CDK.