Commencer à utiliser le AWS CDK - AWS Cloud Development Kit (AWS CDK) v2

Ceci est le guide du AWS CDK développeur de la version 2. L'ancien CDK v1 est entré en maintenance le 1er juin 2022 et a pris fin le 1er juin 2023.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Commencer à utiliser le AWS CDK

Commencez avec le AWS Cloud Development Kit (AWS CDK) en installant AWS CDK CLI et en créant votre première application CDK.

Prérequis

Ressources recommandées

Avant de commencer à utiliser le AWS CDK, nous vous recommandons de bien comprendre les éléments suivants :

Préparez votre environnement local

Tous les AWS CDK développeurs, quelle que soit votre langue préférée, ont besoin de la version Node.js14.15.0 ou ultérieure. Tous les langages de programmation pris en charge utilisent le même backend, qui s'exécute surNode.js. Nous recommandons une version avec support actif à long terme. Il se peut que votre organisation ait une recommandation différente.

Important

Les versions 13.0.0 à 13.6.0 de Node.js ne sont pas compatibles avec le AWS CDK en raison de problèmes de compatibilité liés à ses dépendances.

Les autres prérequis dépendent de la langue dans laquelle vous développez des AWS CDK applications et sont les suivants.

TypeScript
  • TypeScript 3.8 ou version ultérieure (npm -g install typescript)

JavaScript

Aucune exigence supplémentaire

Python
  • Python 3.7 ou version ultérieure, y compris pip et virtualenv

Java
  • Kit de développement Java (JDK) 8 (alias 1.8) ou version ultérieure

  • Apache Maven 3.5 ou version ultérieure

L'IDE Java est recommandé (nous utilisons Eclipse dans certains exemples de ce guide). L'IDE doit être capable d'importer des projets Maven. Vérifiez que votre projet est configuré pour utiliser Java 1.8. Définissez la variable d'environnement JAVA_HOME sur le chemin où vous avez installé le JDK.

C#

.NET Core 3.1 ou version ultérieure, ou .NET 6.0 ou version ultérieure.

Visual Studio 2019 (n'importe quelle édition) ou Visual Studio Code sont recommandés.

Go

Go 1.1.8 ou version ultérieure.

Pour des informations plus détaillées, consultez la section Conditions requises pour votre langue :

Obsolète d'un langage tiers

Chaque version linguistique n'est prise en charge que jusqu'à ce qu'elle le soit EOL (fin de vie) et peut être modifiée avec préavis.

Étape 1 : Création d'un Compte AWS

Si vous êtes nouveau AWS, vous devez vous inscrire à un Compte AWS et créer un utilisateur administratif. Pour plus d'informations, consultez la section Configuration avec IAM dans le Guide de l'utilisateur d'IAM.

Lorsque vous interagissez avec AWS, vous spécifiez vos informations de AWS sécurité pour vérifier qui vous êtes et si vous êtes autorisé à accéder aux ressources que vous demandez. AWS utilise les informations d'identification de sécurité pour authentifier et autoriser vos demandes. Pour en savoir plus, consultez les informations d'identification AWS de sécurité dans le guide de l'utilisateur IAM.

Étape 2 : Configuration de l'accès par programmation

Lorsque vous développez avec le AWS CDK dans votre environnement local, vous compterez sur le AWS CDK CLI pour interagir avec vos AWS ressources Services AWS et les gérer. Pour utiliser le AWS CDK CLI, vous devez configurer l'accès par programmation. Pour en savoir plus sur les différentes manières de configurer l'accès par programmation, consultez Authentification et accès dans le Guide de référence AWS des SDK et des outils.

Pour les nouveaux utilisateurs qui n'ont pas reçu de méthode d'authentification de la part de leur employeur, nous vous recommandons d'utiliser AWS IAM Identity Center. Cette méthode consiste à installer le AWS Command Line Interface (AWS CLI) et à l'utiliser pour la configuration et la connexion au portail AWS d'accès. Pour configurer l'accès par programmation à l'aide d'IAM Identity Center, consultez la section Authentification IAM Identity Center dans le Guide de référence AWS des SDK et des outils. Une fois terminé, votre environnement doit contenir les éléments suivants :

  • Le AWS CLI, que vous utilisez pour démarrer une session de portail d' AWS accès avant d'exécuter votre application.

  • AWSconfigFichier partagé comportant un [default] profil avec un ensemble de valeurs de configuration pouvant être référencées à partir du AWS CDK. Pour connaître l'emplacement de ce fichier, consultez Location of the shared files dans le manuel AWS SDKs and Tools Reference Guide.

  • Le config fichier partagé définit le regionparamètre. Cela définit les AWS CDK utilisations par défaut Région AWS pour les AWS demandes.

  • AWS CDK Utilise la configuration du fournisseur de jetons SSO du profil pour obtenir des informations d'identification avant d'envoyer des demandes à AWS. La sso_role_name valeur, qui est un rôle IAM connecté à un ensemble d'autorisations IAM Identity Center, doit autoriser l'accès à l'utilisateur dans Services AWS votre application.

    Le config fichier d'exemple suivant montre un profil par défaut configuré avec la configuration du fournisseur de jetons SSO. Le sso_session paramètre du profil fait référence à la sso-sessionsection nommée. La sso-session section contient les paramètres permettant de lancer une session sur le portail AWS d'accès.

    [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

Démarrer une session sur le portail AWS d'accès

Avant d'y accéder Services AWS, vous devez disposer d'une session de portail AWS d'accès active AWS CDK pour utiliser l'authentification IAM Identity Center afin de résoudre les informations d'identification. En fonction de la durée de votre session configurée, votre accès finira par expirer et une erreur d'authentification AWS CDK se produira. Exécutez la commande suivante dans le AWS CLI pour vous connecter au portail AWS d'accès.

aws sso login

Si la configuration de votre fournisseur de jetons SSO utilise un profil nommé au lieu du profil par défaut, la commande estaws sso login --profile NAME. Spécifiez également ce profil lors de l'émission de cdk commandes à l'aide de l'--profileoption ou de la variable d'AWS_PROFILEenvironnement.

Pour vérifier si vous avez déjà une session active, exécutez la AWS CLI commande suivante.

aws sts get-caller-identity

La réponse à cette commande doit indiquer le compte IAM Identity Center et l'ensemble d'autorisations configurés dans le fichier partagé config.

Note

Si vous disposez déjà d'une session active sur le portail AWS d'accès et que vous l'exécutezaws sso login, il ne vous sera pas demandé de fournir d'informations d'identification.

Le processus de connexion peut vous demander d'autoriser l' AWS CLI accès à vos données. Étant donné que le AWS CLI est construit au-dessus du SDK pour Python, les messages d'autorisation peuvent contenir des variantes du botocore nom.

Étape 3 : installez le AWS CDKCLI

Installez le AWS CDK CLI globalement à l'aide de la commande Node Package Manager suivante.

npm install -g aws-cdk
Note

Si une erreur d'autorisation s'affiche et que vous disposez d'un accès administrateur sur votre système, essayezsudo npm install -g aws-cdk.

Exécutez la commande suivante pour vérifier la réussite de l'installation. Le numéro de version AWS CDK CLI doit être affiché :

cdk --version

Si vous recevez un message d'erreur, essayez de le désinstaller AWS CDK CLI en exécutant ce qui suit :

npm uninstall -g aws-cdk

Répétez ensuite les étapes pour réinstaller le AWS CDK CLI.

Si le message d'erreur persiste, supprimez le node-modules dossier du projet en cours ainsi que du node-modules dossier global. Pour localiser ce dossier, exécuteznpm config get prefix.

Vous AWS CDK CLI obtiendrez les informations d'identification de sécurité à partir des sources que vous avez configurées lors des étapes précédentes.

Note

Le CDK Toolkit v2 fonctionne avec les projets CDK v1 existants. Cependant, il ne peut pas initialiser de nouveaux projets CDK v1. Voyez Nouveaux prérequis si vous devez être capable de le faire.

Étape 4 : Bootstrap votre environnement

Chaque AWS environnement dans lequel vous prévoyez de déployer des ressources doit être amorcé.

Pour démarrer, exécutez ce qui suit :

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

Si vous n'avez pas votre numéro de AWS compte à portée de main, vous pouvez l'obtenir auprès du AWS Management Console. Ou, si vous l'avez AWS CLI installé, la commande suivante affiche les informations de votre compte par défaut, y compris le numéro de compte.

aws sts get-caller-identity

Si vous avez créé des profils nommés dans votre AWS configuration locale, vous pouvez utiliser --profile cette option pour afficher les informations de compte pour un profil spécifique. L'exemple suivant montre comment afficher les informations de compte pour le profil de production.

aws sts get-caller-identity --profile prod

Pour afficher la région par défaut, utilisezaws configure get.

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

AWS CDK Outils optionnels

Il s'AWS Toolkit for Visual Studio Codeagit d'un plug-in open source pour Visual Studio Code qui vous permet de créer, de déboguer et de déployer des applications sur AWS. La boîte à outils fournit une expérience intégrée pour le développement AWS CDK d'applications. Il inclut la fonctionnalité AWS CDK Explorer pour répertorier vos AWS CDK projets et parcourir les différents composants de l'application CDK. Installez le plug-in et apprenez-en plus sur l'utilisation de l' AWS CDK explorateur.

Étapes suivantes

Maintenant que vous l'avez installé AWS CDK CLI, utilisez-le pour créer votre première AWS CDK application.

Pour en savoir plus sur l'utilisation du AWS CDK dans votre langage de programmation préféré, consultezUtilisation des langages AWS CDK de programmation pris en charge.

AWS CDK Il s'agit d'un projet open source. Pour contribuer, voir Contribuer au AWS Cloud Development Kit (AWS CDK).

En savoir plus

Pour en savoir plus à ce sujet AWS CDK, consultez les rubriques suivantes :