Começando com o AWS CDK - AWS Cloud Development Kit (AWS CDK) v2
Pré-requisitosEtapa 1: criar um Conta da AWSEtapa 2: Configurar o acesso programáticoEtapa 3: instalar o AWS CDKCLIEtapa 4: inicialize seu ambienteAWS CDK Ferramentas opcionaisPróximas etapasSaiba mais

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

Começando com o AWS CDK

Comece com o AWS Cloud Development Kit (AWS CDK) instalando AWS CDK CLI e criando seu primeiro aplicativo CDK.

Tópicos

Pré-requisitos

Recursos recomendados

Antes de começar a usar o AWS CDK, recomendamos uma compreensão básica do seguinte:

Prepare seu ambiente local

Todos os AWS CDK desenvolvedores, independentemente do seu idioma preferido, precisam da versão Node.js14.15.0 ou posterior. Todas as linguagens de programação suportadas usam o mesmo back-end, que é executado emNode.js. Recomendamos uma versão com suporte ativo de longo prazo. Sua organização pode ter uma recomendação diferente.

Importante

As versões 13.0.0 a 13.6.0 do Node.js não são compatíveis com o AWS CDK devido a problemas de compatibilidade com suas dependências.

Outros pré-requisitos dependem da linguagem na qual você desenvolve AWS CDK aplicativos e são os seguintes.

TypeScript

  • TypeScript 3.8 ou posterior () npm -g install typescript

JavaScript

Sem requisitos adicionais

Python

  • Python 3.7 ou posterior, incluindo e pip virtualenv

Java

  • Java Development Kit (JDK) 8 (também conhecido como 1.8) ou posterior

  • Apache Maven 3.5 ou posterior

O Java IDE é recomendado (usamos o Eclipse em alguns exemplos neste guia). O IDE deve ser capaz de importar projetos Maven. Verifique se o seu projeto está configurado para usar o Java 1.8. Defina a variável de ambiente JAVA_HOME para o caminho em que você instalou o JDK.

C#

.NET Core 3.1 ou posterior, ou.NET 6.0 ou posterior.

Recomenda-se o Visual Studio 2019 (qualquer edição) ou o Visual Studio Code.

Go

Vá para a versão 1.1.8 ou posterior.

Para obter informações mais detalhadas, consulte a seção Pré-requisitos do seu idioma:

Suspensão de uso de linguagem de terceiros

Cada versão de idioma só é suportada até o fim da vida útil e está sujeita a alterações mediante aviso prévio. EOL

Etapa 1: criar um Conta da AWS

Se você for iniciante AWS, deverá se inscrever em um Conta da AWS e criar um usuário administrativo. Para obter mais informações, consulte Como configurar com o IAM no Guia do usuário do IAM.

Ao interagir com AWS, você especifica suas credenciais de AWS segurança para verificar quem você é e se tem permissão para acessar os recursos que está solicitando. AWS usa as credenciais de segurança para autenticar e autorizar suas solicitações. Para saber mais, consulte as credenciais AWS de segurança no Guia do usuário do IAM.

Etapa 2: Configurar o acesso programático

Ao desenvolver com o AWS CDK em seu ambiente local, você confiará no AWS CDK CLI para interagir Serviços da AWS e gerenciar seus AWS recursos. Para usar o AWS CDK CLI, você deve configurar o acesso programático. Para saber mais sobre as diferentes formas de configurar o acesso programático, consulte Autenticação e acesso no Guia de referência de AWS SDKs e ferramentas.

Para novos usuários que não recebem um método de autenticação do empregador, recomendamos o uso AWS IAM Identity Center. Esse método inclui instalar o AWS Command Line Interface (AWS CLI) e usá-lo para configuração e login no portal de AWS acesso. Para configurar o acesso programático usando o IAM Identity Center, consulte a autenticação do IAM Identity Center no Guia de referência de AWS SDKs e ferramentas. Após a conclusão, seu ambiente deve conter os seguintes elementos:

  • O AWS CLI, que você usa para iniciar uma sessão do portal de AWS acesso antes de executar seu aplicativo.

  • Um AWSconfigarquivo compartilhado com um [default] perfil com um conjunto de valores de configuração que podem ser referenciados a AWS CDK partir do. Para encontrar a localização desse arquivo, consulte Localização dos arquivos compartilhados no Guia de referência de ferramentas e SDKs da AWS .

  • O arquivo config compartilhado define a configuração da region. Isso define como padrão Região da AWS os AWS CDK usos das AWS solicitações.

  • O AWS CDK usa a configuração do provedor de token SSO do perfil para adquirir credenciais antes de enviar solicitações para. AWS O sso_role_name valor, que é uma função do IAM 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 arquivo de exemplo config a seguir mostra um perfil padrão configurado com a configuração do provedor de token de SSO. A configuração sso_session do perfil se refere à seção chamada sso-session. A sso-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-session my-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 usar AWS CDK a autenticação do IAM Identity Center para resolver as credenciais. Dependendo da duração da sessão configurada, seu acesso acabará expirando e AWS CDK ocorrerá 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 token SSO estiver usando um perfil nomeado em vez do perfil padrão, o comando seráaws sso login --profile NAME. Especifique também esse perfil ao emitir cdk comandos usando a --profile opção ou a variável de AWS_PROFILE ambiente.

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 do Centro de Identidade do IAM e o conjunto de permissões configurados no arquivo compartilhado config.

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 sobre o SDK para Python, as mensagens de permissão podem conter variações do botocore nome.

Etapa 3: instalar o AWS CDKCLI

Instale o AWS CDK CLI globalmente usando o seguinte comando Node do Package Manager.

npm install -g aws-cdk
nota

Se você receber um erro de permissão e tiver acesso de administrador em seu sistema, tentesudo npm install -g aws-cdk.

Execute o comando a seguir para verificar se a instalação foi bem-sucedida. O AWS CDK CLI deve gerar o número da versão:

cdk --version

Se você receber uma mensagem de erro, tente desinstalar o AWS CDK CLI executando o seguinte:

npm uninstall -g aws-cdk

Em seguida, repita as etapas para reinstalar o. AWS CDK CLI

Se você ainda receber um erro, exclua a node-modules pasta do projeto atual e também da node-modules pasta global. Para localizar essa pasta, executenpm config get prefix.

Eles AWS CDK CLI obterão credenciais de segurança de fontes que você configurou nas etapas anteriores.

nota

O CDK Toolkit v2 funciona com projetos CDK v1 existentes. No entanto, ele não pode inicializar novos projetos CDK v1. Veja Novos pré-requisitos se você precisa ser capaz de fazer isso.

Etapa 4: inicialize seu ambiente

Cada AWS ambiente no qual você planeja implantar recursos deve ser inicializado.

Para inicializar, execute o seguinte:

cdk bootstrap aws://ACCOUNT-NUMBER/REGION
dica

Se você não tiver o número AWS da sua conta em mãos, você pode obtê-lo no AWS Management Console. Ou, se você tiver o AWS CLI instalado, o comando a seguir exibirá as informações padrão da sua conta, incluindo o número da conta.

aws sts get-caller-identity

Se você criou perfis nomeados em sua AWS configuração local, você pode usar a --profile opção para exibir as informações da conta para um perfil específico. O exemplo a seguir mostra como exibir as informações da conta para o perfil prod.

aws sts get-caller-identity --profile prod

Para exibir a região padrão, useaws configure get.

aws configure get region
aws configure get region --profile prod

AWS CDK Ferramentas opcionais

AWS Toolkit for Visual Studio CodeÉ um plug-in de código aberto para o Visual Studio Code que ajuda você a criar, depurar e implantar aplicativos no. AWS O kit de ferramentas fornece uma experiência integrada para o desenvolvimento de AWS CDK aplicativos. Ele inclui o recurso AWS CDK Explorer para listar seus AWS CDK projetos e navegar pelos vários componentes do aplicativo CDK. Instale o plug-in e saiba mais sobre como usar o AWS CDK Explorer.

Próximas etapas

Agora que você instalou o AWS CDK CLI, use-o para criar seu primeiro AWS CDK aplicativo.

Para saber mais sobre como usar o AWS CDK em sua linguagem de programação preferida, consulteTrabalhando com o AWS CDK em linguagens de programação suportadas.

AWS CDK É um projeto de código aberto. Para contribuir, consulte Contribuindo para AWS Cloud Development Kit (AWS CDK) o.

Saiba mais

Para saber mais sobre o AWS CDK, consulte o seguinte: