Développement de fonctions Lambda localement avec VS Code - AWS Lambda
Principaux avantages du développement localPrérequisAuthentification et contrôle d’accèsDéplacement de la console au développement localUtilisation des fonctions localementConvertir votre fonction en modèle AWS SAM et utiliser les outils IaCÉtapes suivantes

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.

Développement de fonctions Lambda localement avec VS Code

Vous pouvez déplacer vos fonctions Lambda de la console Lambda vers Visual Studio Code, qui fournit un environnement de développement complet et vous permet d’utiliser d’autres options de développement locales, comme AWS SAM et AWS CDK.

Principaux avantages du développement local

Bien que la console Lambda permette de modifier et de tester rapidement des fonctions, le développement local offre des fonctionnalités plus avancées :

  • Fonctionnalités avancées de l’IDE : outils de débogage, de complétion de code et de refactorisation

  • Développement hors ligne : travaillez et testez les modifications localement avant de les déployer dans le cloud

  • Intégration de l’infrastructure en tant que code : utilisation fluide avec AWS SAM, AWS CDK et Infrastructure Composer

  • Gestion des dépendances : contrôle total sur les dépendances des fonctions

Prérequis

Avant de développer des fonctions Lambda localement dans VS Code, vous devez disposer de ce qui suit :

Note

Si vous avez déjà configuré un compte AWS et un profil localement, assurez-vous que la politique gérée AdministratorAccess est ajoutée à votre profil AWS configuré.

Authentification et contrôle d’accès

Pour développer des fonctions Lambda localement, vous avez besoin d’informations d’identification AWS pour accéder aux ressources AWS de façon sécurisée et les gérer en votre nom, comme cela se produirait dans le cloud. AWS Toolkit pour VS Code prend en charge les méthodes d’authentification suivantes :

AWS Toolkit pour VS Code prend en charge les méthodes d’authentification suivantes :

  • Informations d’identification à long terme des utilisateurs IAM

  • Informations d’identification temporaires de rôles assumés

  • Fédération des identités

  • Informations d’identification d’utilisateur racine du compte AWS (non recommandé)

Cette section vous explique comment obtenir et configurer ces informations d’identification à l’aide des informations d’identification à long terme d’utilisateur IAM.

Obtenir les informations d’identification IAM

Si un utilisateur IAM possède déjà des clés d’accès, préparez l’ID de clé d’accès et la clé d’accès secrète pour la section suivante. Si vous ne possédez pas ces clés, suivez ces étapes pour les créer :

Note

Vous devez utiliser à la fois l'ID de la clé d'accès et la clé d'accès secrète pour authentifier vos demandes.

Pour créer un utilisateur IAM et des clés d’accès :

  1. Ouvrez la console IAM à l’adresse https://console.aws.amazon.com/iam.

  2. Dans le panneau de navigation, choisissez utilisateurs.

  3. Choisissez Create user (Créer un utilisateur).

  4. Dans Nom d’utilisateur, entrez un nom et choisissez Suivant.

  5. Pour Set permissions (Définir les autorisations), sélectionnez Attacher directement les stratégies.

  6. Sélectionnez AdministratorAccess, puis Suivant.

  7. Choisissez Create user (Créer un utilisateur).

  8. Dans la bannière indiquant le succès, choisissez Voir l’utilisateur.

  9. Choisissez Create access key (Créer une clé d’accès).

  10. Pour Cas d’utilisation, sélectionnez Code local.

  11. Cochez la case de confirmation et choisissez Suivant.

  12. (Facultatif) Entrez une valeur de balise de description.

  13. Choisissez Create access key (Créer une clé d’accès).

  14. Copiez immédiatement votre clé d’accès et votre clé d’accès secrète. Vous ne pourrez plus accéder à la clé d’accès secrète après avoir quitté cette page.

Important

Ne partagez jamais votre clé secrète et ne la confiez jamais au contrôle de source. Stockez ces clés en toute sécurité et supprimez-les lorsqu’elles ne sont plus nécessaires.

Note

Pour plus d’informations, consultez les Créer un utilisateur IAM dans votre compte AWS et Gérer les clés d’accès pour les utilisateurs IAM dans le Guide de l’utilisateur IAM.

Configurer les informations d’identification AWS à l’aide d’AWS Toolkit

Le tableau suivant récapitule le processus de configuration des informations d’identification que vous allez effectuer dans le cadre de la procédure suivante.

Que faire Pourquoi ?
Ouvrez le panneau Connexion Démarrer l’authentification
Utilisez la palette de commandes et recherchez Ajouter une nouvelle connexion AWS Accédez à l’interface de connexion
Choisissez Informations d’identification IAM Utiliser vos clés d’accès pour l’accès programmatique
Saisissez le nom du profil, la clé d’accès et la clé secrète Fournir les informations d’identification pour la connexion
Consultez la mise à jour de l’explorateur AWS Confirmez que vous êtes connecté

Procédez comme suit pour vous authentifier auprès de votre compte AWS :

  1. Ouvrez le panneau Connexion dans VS Code :

    1. Pour démarrer le processus d’authentification, sélectionnez l’icône AWS dans le volet de navigation de gauche ou ouvrez la palette de commandes (Cmd+Maj+P sur Mac ou Ctrl+Maj+P sur Windows/Linux), recherchez et sélectionnez Ajouter une nouvelle connexion AWS.

  2. Dans le panneau de connexion, choisissez Informations d’identification IAM, puis sélectionnez Continuer.

    Note

    Pour continuer, vous devez autoriser les extensions IDE AWS pour VS Code à accéder à vos données.

  3. Saisissez le nom de votre profil, l’ID de clé d’accès et la clé d’accès secrète, puis sélectionnez Continuer.

  4. Vérifiez la connexion en observant l’explorateur AWS dans VS Code pour vos services et ressources AWS.

Pour plus d’informations sur la configuration de l’authentification avec des informations d’identification à long terme, consultez Utilisation d’informations d’identification à long terme pour authentifier les SDK et outils AWS.

Pour plus d’informations sur la configuration de l’authentification, consultez Informations d’identification AWS IAM dans le Guide de l’utilisateur AWS Toolkit for Visual Studio Code.

Déplacement de la console au développement local

Note

Si vous avez apporté des modifications à la console, assurez-vous qu’il n’y a aucune modification non déployée avant de passer au développement local.

Pour déplacer une fonction Lambda de la console Lambda vers VS Code, procédez comme suit :

  1. Ouvrez la console Lambda.

  2. Choisissez le nom de votre fonction .

  3. Sélectionnez l’onglet Source du code.

  4. Choisissez Ouvrir dans Visual Studio Code.

    Note

    Le bouton Ouvrir dans Visual Studio Code n’est disponible que dans les versions 3.69.0 et ultérieures d’AWS Toolkit. Si une version antérieure d’AWS Toolkit est installée, un message Cannot open the handler peut s’afficher dans VS Code. Pour résoudre ce problème, mettez à jour AWS Toolkit vers la dernière version.

  5. Lorsque vous y êtes invité, autorisez votre navigateur à ouvrir VS Code.

Lorsque vous ouvrez votre fonction dans VS Code, Lambda crée un projet local avec le code de votre fonction dans un emplacement temporaire conçu pour des tests et un déploiement rapides. Cela inclut le code de fonction, les dépendances et une structure de projet de base que vous pouvez utiliser pour le développement local.

Pour plus de détails sur l’utilisation d’AWS dans VS Code, consultez le Guide de l’utilisateur AWS Toolkit for Visual Studio Code.

Utilisation des fonctions localement

Après avoir ouvert votre fonction dans VS Code, suivez ces étapes pour accéder à vos fonctions et les gérer :

  1. Sélectionnez l’icône AWS dans la barre latérale pour ouvrir l’explorateur AWS :

    Icône d’AWS Toolkit dans la barre latérale de VS Code

  2. Dans l’explorateur AWS, sélectionnez la région dans laquelle se trouve votre fonction Lambda :

    Explorateur AWS affichant la sélection de régions

  3. Dans la région que vous avez sélectionnée, développez la section Lambda pour voir et gérer vos fonctions :

    Fonctions Lambda avec icônes d’action pour le déploiement, l’invocation, etc.

Une fois votre fonction ouverte dans VS Code, vous pouvez :

  • Modifier le code de fonction avec prise en charge complète du langage et saisie semi-automatique du code.

  • Utilisez l’intégration LocalStack dans VS Code pour tester les fonctions Lambda qui envoient des appels d’API à d’autres Services AWS pendant l’exécution, par exemple en lisant des tables DynamoDB ou en écrivant dans des compartiments Amazon S3. LocalStack est un émulateur de services cloud qui fournit un environnement de développement local complet pour tester les intégrations de service. Vous pouvez également utiliser AWS SAM CLI pour tester votre fonction dans un conteneur local. Si votre fonction fait des appels d’API à d’autres Services AWS, ces appels atteindront des ressources AWS réelles, et non des ressources émulées.

  • Déboguez votre fonction avec des points d’arrêt et l’inspection des variables. Pour plus d’informations, consultez Exécution et débogage de fonctions Lambda directement à partir du code dans le Guide de l’utilisateur AWS Toolkit for Visual Studio Code.

  • Déployez à nouveau votre fonction mise à jour sur AWS en utilisant l’icône cloud.

  • Installez et gérez les dépendances de votre fonction.

Pour plus d’informations, veuillez consulter la section Utilisation des fonctions AWS Lambda dans le guide de l’utilisateur AWS Toolkit for Visual Studio Code.

Convertir votre fonction en modèle AWS SAM et utiliser les outils IaC

Dans VS Code, vous pouvez convertir votre fonction Lambda en modèle AWS SAM en choisissant l’icône Convertir en application AWS SAM à côté de votre fonction Lambda. Vous serez invité à sélectionner l’emplacement d’un projet AWS SAM. Une fois sélectionnée, votre fonction Lambda sera convertie en template.yaml fichier enregistré dans votre nouveau projet AWS SAM.

Une fois votre fonction convertie en modèle AWS SAM, vous pouvez :

  • Contrôler la gestion des versions de votre infrastructure

  • Automatiser les déploiements

  • Déboguer les fonctions à distance

  • Ajouter des ressources AWS supplémentaires à votre application

  • Maintenir des environnements cohérents tout au long de votre cycle de développement

  • Utiliser Infrastructure Composer pour modifier visuellement votre modèle AWS SAM

Pour plus d’informations sur l’utilisation des outils IaC, consultez les guides suivants :

Ces outils fournissent des fonctionnalités supplémentaires pour définir, tester et déployer vos applications sans serveur.

Étapes suivantes

Pour en savoir plus sur l’utilisation des fonctions Lambda dans VS Code, consultez les ressources suivantes :