AWS CloudFormation serveur de langues - AWS CloudFormation
IDEs intégration au serveur AWS CloudFormation de languePrise en mainInitialisation d'un CloudFormation projet dans l'IDEOpen sourceVous avez besoin d'aide ?

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.

AWS CloudFormation serveur de langues

Le serveur de AWS CloudFormation langue fournit des fonctionnalités permettant d'accélérer la création infrastructure-as-code (iAc) et le déploiement AWS des ressources en toute sécurité et en toute confiance. Il suit le protocole du serveur de langage (LSP) pour fournir de la documentation sur le survol, l'auto-complétion, les diagnostics via la validation statique, le passage à la définition et les actions de code. Outre ces fonctionnalités de serveur linguistique traditionnel, le serveur ajoute des fonctionnalités en ligne permettant d'explorer et de déployer AWS des ressources via CloudFormation. Cela inclut la possibilité de valider et de déployer des modèles à l'aide d'ensembles de modifications, d'afficher les différences de pile, les événements, les ressources et les résultats, de répertorier les piles et de parcourir les ressources par type, et d'insérer l'état des ressources en direct directement dans CloudFormation les modèles. Les outils destinés aux développeurs et les environnements de développement intégrés (IDE) peuvent tirer parti des fonctionnalités du serveur de langage pour améliorer l'expérience des développeurs iAc sur CloudFormation ce dernier.

IDEs intégration au serveur AWS CloudFormation de langue

L'extension AWS Toolkit intègre le serveur de CloudFormation langue pour améliorer l'expérience de création. Cette intégration est actuellement prise en charge dans VS Code IDEs, notamment :

Prise en main

Prérequis

Avant de commencer, assurez-vous que :

  • Vous utilisez un IDE basé sur VS Code sur un système d'exploitation compatible (macOS,Windows, ouLinux).

  • Vous avez installé ou effectué une mise à niveau vers la dernière version du AWS Toolkit pour votre IDE.

Certaines fonctionnalités du serveur de AWS CloudFormation langue nécessitent des informations d'identification actives Compte AWS et configurées. Vous devez être connecté à votre compte Compte AWS via le AWS Toolkit à l'aide d'informations d'identification valides.

Étape 1 : Installation ou mise à niveau du AWS kit d'outils

  • Ouvrez les extensions ou le gestionnaire de plugins de votre IDE.

  • Recherchez AWS Toolkit.

  • Installez ou mettez à jour vers la version 3.85.0 ou ultérieure du AWS Toolkit pour votre IDE.

  • Redémarrez votre IDE après l'installation.

Remarque : Après l'installation, le AWS kit d'outils active automatiquement le support CloudFormation IDE. Lorsque vous installez ou mettez à niveau le AWS Toolkit pour la première fois avec l'extension de serveur de AWS CloudFormation langue, vous êtes invité AWS à autoriser la collecte de données d'utilisation anonymes. Ces données permettent AWS d'améliorer le serveur de CloudFormation langue et d'améliorer l'expérience de création. Aucune information sensible n'est collectée et AWS n'enregistre ni ne stocke le contenu des modèles, les configurations des ressources ou les données clients identifiables. Vous pouvez modifier vos préférences de télémétrie à tout moment depuis les paramètres de l'IDE. Les données d'utilisation collectées se concentrent uniquement sur les interactions entre les fonctionnalités et les indicateurs de performance. Ces informations permettent AWS d'identifier et de hiérarchiser les améliorations telles qu'une validation plus rapide, une saisie semi-automatique améliorée et un meilleur diagnostic des erreurs.

Étape 2 : Accès CloudFormation dans le panneau du AWS kit d'outils

Dans votre IDE, ouvrez le panneau AWS Toolkit depuis la barre d'activité. Sous AWS Toolkit, choisissez CLOUDFORMATION.

Sections du panneau :

  • Région : affiche le courant Région AWS. Vous pouvez le modifier en sélectionnant le nom de la région ou en utilisant la commande AWS CloudFormation: Sélectionner une région dans la palette de commandes.

  • Environnement : indique l'environnement que vous avez sélectionné pendant CFN init (par exemple, dev, test ou prod). Cette valeur n'apparaît qu'une fois l'étape de sélection de l'environnement terminée.

  • Piles : affiche une liste paginée des CloudFormation piles de votre compte.

    • Cliquez sur l'icône d'actualisation pour mettre à jour la liste des piles.

    • Utilisez l'icône + pour déployer un nouveau modèle sous forme de pile.

    • Chaque entrée de pile inclut :

      • Vue d'ensemble : affiche le résumé et le statut de la pile

      • ID de pile

      • Description

      • Heure de création et heure de mise à jour

      • Statut et raison du statut

      • Événements, résultats et ressources

    • Modifier le set

  • Ressources : une fois que vous avez sélectionné un type de ressource, le panneau affiche les AWS ressources de ce type dans votre compte. Vous pouvez les afficher, les actualiser, les copier ou les importer dans votre modèle.

Étape 3 : Validez, testez et affinez votre modèle

Lorsque vous rédigez votre CloudFormation modèle, l'IDE fournit une assistance intelligente à la création pour vous aider à créer plus rapidement une infrastructure précise et conforme. Le serveur de CloudFormation langue s'exécute en arrière-plan et fournit les fonctionnalités de création suivantes :

  • Complétion du code : suggère des types de ressources, des paramètres et des propriétés en fonction de CloudFormation schémas.

  • Ajouter AWS des ressources existantes : vous permet d'importer des ressources existantes depuis votre Compte AWS modèle. L'IDE utilise le API de commande du Cloud AWS (CCAPI) pour récupérer la configuration en direct et les propriétés de la ressource, afin de vous aider à cloner ou à réutiliser l'infrastructure existante dans votre modèle.

Pour ajouter des ressources à votre modèle

  • Développez le panneau CloudFormation Ressources : dans le panneau latéral de la AWS boîte à outils CloudFormation, développez, puis sous Ressources, cliquez sur l'icône Ajouter +.

  • Rechercher un type de ressource : pour rechercher un type de AWS ressource spécifique, saisissez le type de AWS ressource spécifique que vous souhaitez ajouter dans la barre de recherche. Exemple :

    • AWS::S3::Bucket

    • AWS::Lambda::Function

    Vous pouvez sélectionner le type de ressource en utilisant AWS CloudFormation: Ajouter des types de ressources dans la palette de commandes.

  • Ajouter des ressources à votre modèle : sous le panneau Ressources, une liste paginée des AWS ressources détectées dans votre compte s'affiche. Si vous avez de nombreuses ressources, seule la première page est affichée. Utilisez les commandes de navigation situées au bas du panneau pour parcourir les pages supplémentaires et consulter toutes les ressources disponibles.

  • Choisissez la ressource que vous souhaitez inclure dans votre modèle.

  • Vous pouvez insérer une ressource dans votre modèle de deux manières, en fonction de votre objectif :

    • Cloner une ressource existante : créez une nouvelle ressource dans votre modèle en utilisant la configuration en direct et les propriétés d'une AWS ressource existante.

    • Importer une ressource existante : insérez la ressource réelle dans votre pile en l'ajoutant à votre modèle en utilisant son état actif.

Conseils

  • Vous pouvez actualiser le panneau Ressources à tout moment pour consulter la dernière liste des ressources disponibles dans votre compte ou dans votre région.

  • Si vous importez des ressources, n'ajoutez pas de ressource qui appartient déjà à une CloudFormation pile existante dans le même compte.

  • Pour vérifier si une ressource est déjà gérée par CloudFormation, cliquez sur l'icône i (information) à côté du nom de la ressource.

  • Vous pouvez également utiliser la commande AWS CloudFormation Get Stack Management Info pour vérifier si une ressource appartient à une pile.

Vous pouvez ajouter des ressources connexes à la ressource sélectionnée à l'aide de la commande AWS CloudFormation: Ajouter des ressources connexes par type. Une fois que vous avez sélectionné un type de ressource parmi ceux déjà définis dans votre modèle, l'IDE affiche une liste de ressources généralement associées ou dépendantes de ce type. Par exemple, si vous sélectionnez unAWS::EC2::Instance, l'IDE peut suggérer d'ajouter des ressources connexes telles que AWS::EC2::SecurityGroup ouAWS::EC2::Subnet. Cette fonctionnalité vous permet de créer rapidement des composants d'infrastructure connectés sans rechercher manuellement des types de ressources compatibles.

Validation statique

L' CloudFormation IDE fournit une validation statique intégrée alimentée par AWS CloudFormation Linter (cfn-lint) et. AWS CloudFormation Guard Ces validations s'exécutent en arrière-plan lorsque vous créez des modèles, ce qui vous aide à identifier les erreurs de syntaxe, les lacunes de conformité et les problèmes liés aux meilleures pratiques avant le déploiement.

Vue d'ensemble de la validation statique

Vous verrez deux types de validations statiques en temps réel dans l'IDE :

  • CloudFormation Linter (cfn-lint) : valide votre modèle par rapport aux spécifications CloudFormation des ressources et aux règles du schéma.

  • Guard (cfn-guard) : valide votre modèle par rapport aux règles de conformité et aux packs de politiques organisationnelles.

CloudFormation Linter (cfn-lint)

Le CloudFormation Linter est intégré à l'IDE pour vérifier automatiquement la syntaxe et la structure de votre modèle au fur et à mesure que vous tapez.

  • Validation du schéma : détecte les erreurs de syntaxe et de schéma pour garantir que vos modèles sont conformes au schéma CloudFormation des ressources.

  • Surlignage des erreurs : affiche des lignes ondulées rouges ou jaunes sous les problèmes, représentant les bloqueurs de déploiement ou les avertissements.

  • Survolez l'aide : lorsque vous survolez une erreur, l'IDE affiche le message de diagnostic associé à ce problème. Si une solution rapide est disponible, elle sera également proposée dans le panneau de survol.

Intégration de Guard

Guard valide vos modèles par rapport à des ensembles de règles qui définissent les politiques de conformité et de sécurité. L'IDE exécute les validations Guard en temps réel via le serveur de CloudFormation langue, ce qui vous permet de recevoir des commentaires immédiats lorsque vous créez des modèles.

  • Packs de règles par défaut : l'IDE inclut un ensemble préenregistré de règles Guard axées sur les meilleures pratiques fondamentales en matière de sécurité des ressources et d'hygiène de configuration. Pour en savoir plus, cliquez sur le lien vers le registre des règles de garde.

  • Ajout de packs de règles : pour ajouter ou modifier des ensembles de règles, ouvrez Paramètres, Guard et sélectionnez ou téléchargez des packs de règles Guard supplémentaires.

Conseils : Comprendre les indicateurs linéaires ondulés

  • Gilets bleus : conseils sur les meilleures pratiques ou recommandations d'optimisation.

  • Gribouillis jaunes : avertissements concernant des problèmes non bloquants (par exemple, des balises ou des paramètres manquants).

  • Gribouillis rouges : bloqueurs de déploiement tels que des noms de propriété non valides, des champs obligatoires manquants ou des incohérences de schéma.

Étape 4 : Naviguez dans le modèle

Lorsque vous cliquez sur un fichier modèle dans l'explorateur, le panneau Plan affiche automatiquement une vue hiérarchique structurée de votre CloudFormation modèle. Il organise le modèle en sections telles queParameters,Resources, et OutputsMappings, et affiche chaque type de ressource et chaque ID logique. Cela permet de localiser et de naviguer rapidement vers des ressources ou des paramètres spécifiques dans de grands modèles.

Vous pouvez utiliser Go to Definition pour des fonctions intrinsèques telles que GetAtt etRef, ce qui vous permet d'accéder directement à la ressource ou au paramètre référencé dans votre modèle. Cela vous permet de suivre les dépendances, de comprendre les relations entre les ressources et d'apporter des modifications plus efficacement.

Étape 5 : Valider et déployer

Lorsque vous êtes prêt à déployer votre CloudFormation modèle, ouvrez la palette de commandes et exécutez AWS CloudFormation: Valider et déployer. La commande valide votre modèle, et si aucune erreur de blocage n'est détectée, elle passe à la phase de déploiement. Avant de confirmer, l'IDE affiche un résumé de l'ensemble de modifications sensible à la dérive et une vue des différences afin que vous puissiez consulter toutes les modifications proposées.

Comment fonctionne la validation

L'IDE effectue automatiquement un contrôle de validation avant le déploiement et valide votre modèle par rapport aux causes de défaillance courantes, notamment :

  • Syntaxe de propriété non valide ou incompatibilité du schéma : ces problèmes sont généralement détectés cfn-lint lors de la création, mais si un utilisateur procède au déploiement sans y remédier, la validation au moment CloudFormation du déploiement fera apparaître les mêmes erreurs avant la création ou la mise à jour de la pile.

  • Le nom de la ressource est en conflit avec les ressources existantes de votre compte.

  • Contraintes spécifiques au service, telles que les conflits de noms de compartiment S3 ou l'absence de chiffrement.

Si la validation détecte des erreurs, l'IDE met en évidence les problèmes directement dans votre modèle à l'aide de lignes ondulées rouges ou jaunes et répertorie les erreurs dans le panneau PROBLEMS. Chaque problème inclut la propriété ou la ressource spécifique à l'origine de l'échec, ainsi qu'une solution suggérée. S'il n'y a aucune erreur de blocage, vous pouvez passer à la phase de déploiement.

Si des avertissements sont détectés (problèmes non bloquants), une boîte de dialogue apparaît vous permettant de poursuivre le déploiement ou d'annuler et d'apporter des corrections.

L'IDE ouvre un ensemble de modifications sensible à la dérive qui affiche les différences entre votre modèle actuel et la configuration de la pile déployée. Cela vous permet de revoir, de confirmer ou d'annuler la modification définie avant son exécution.

Remarque : Les ensembles de modifications sensibles à la dérive améliorent le processus de CloudFormation déploiement en vous permettant de gérer la dérive de pile en toute sécurité. La dérive de pile se produit lorsque l'état réel de vos ressources diffère de ce qui est défini dans votre CloudFormation modèle, souvent en raison de modifications manuelles effectuées via la AWS Management Console CLI ou le SDK. CloudFormationchange set sensible à la dérive compare la configuration de votre stack traitée à l'état réel des ressources, et l'IDE met en évidence ces différences afin que vous puissiez remettre les ressources en conformité avant le déploiement.

Afficher les événements de la pile

Lorsque le déploiement démarre, vous pouvez accéder à l'CloudFormationonglet du panneau pour suivre la progression en temps réel. Sous Stack Events, vous verrez une liste des opérations effectuées pendant le déploiement. Chaque événement inclut des détails tels que :

  • Horodatage : heure à laquelle l'événement s'est produit

  • Ressource : AWS ressource spécifique créée, mise à jour ou supprimée

  • État : état actuel de l'opération (par exempleCREATE_IN_PROGRESS,UPDATE_COMPLETE, ouROLLBACK_IN_PROGRESS)

  • Motif : Contexte ou messages d'erreur supplémentaires, le cas échéant

Vous pouvez également consulter les ressources et les résultats de la pile à partir de ce panneau. Si vous souhaitez ouvrir la pile dans le AWS Management Console, utilisez l'icône de lien externe à côté du nom de la pile. La vue Stack Events vous permet de suivre la progression du déploiement, d'identifier les problèmes potentiels et de confirmer si votre stack est terminé avec succès.

Initialisation d'un CloudFormation projet dans l'IDE

L'initialisation d'un CloudFormation projet dans l'IDE vous permet de configurer un espace de travail structuré avec les dossiers, la configuration de l'environnement et les AWS informations d'identification appropriés afin que vous puissiez valider et déployer vos modèles de manière fiable. Vous pouvez initialiser un nouveau CloudFormation projet directement depuis l'IDE pour créer cette configuration recommandée.

Pour initialiser un CloudFormation projet :

  • Ouvrez la palette de commandes

    • Depuis votre IDE, ouvrez la palette de commandes (Ctrl+Shift+Pou Cmd+Shift+P activez-lamacOS).

    • Choisissez AWS CloudFormation: CFN Init : Initialiser le projet.

  • Choisissez un répertoire de projets

    • Par défaut, l'IDE utilise votre répertoire de travail actuel.

    • Vous pouvez modifier ce chemin vers n'importe quel dossier dans lequel vous souhaitez stocker vos CloudFormation modèles.

  • Sélectionnez votre profil AWS d'identification

    • Vous serez invité à choisir un profil AWS d'identification. Le profil sélectionné sera utilisé pour la détection de l'environnement, les validations et les déploiements.

  • Configurez votre environnement

    • Vous serez invité à créer ou à sélectionner un environnement.

    • Les environnements définissent où et comment vos modèles seront déployés ou validés (par exemple, en phase de développement, de version bêta ou de production). Vous pouvez utiliser AWS CloudFormation: CFN Init : Ajouter un environnement pour sélectionner ou modifier votre environnement.

    • Vous pouvez utiliser AWS CloudFormation: CFN Init : Remove Environment pour supprimer l'environnement que vous avez sélectionné.

  • (Facultatif) Importer des fichiers de paramètres

    • Si vous avez déjà des fichiers de paramètres existants, l'IDE vous permet de les importer lors de l'initialisation.

    • L'IDE détecte automatiquement les fichiers compatibles et les lie à votre projet pour les utiliser dans le cadre de la validation et du déploiement des modèles.

  • Nommer et finaliser le projet

    • Entrez un nom de projet, tel que l'environnement bêta, et terminez la configuration.

    • L'IDE crée pour vous la structure initiale du projet et le fichier de configuration.

Vous pouvez exécuter des validations, prévisualiser des déploiements ou passer d'un environnement à un autre directement depuis l'IDE.

Open source

Le serveur de AWS CloudFormation langue est open source dans le cadre de la Apache-2.0 licence, offrant aux clients une transparence totale sur la manière dont les diagnostics des modèles, la validation des schémas et les analyses statiques sont effectués. Cela réduit les difficultés liées à la sécurité et à la conformité pour les clients qui ont besoin d'une visibilité au niveau de la source avant d'adopter un outillage.

La base de code est accessible au public sur GitHub : https://github.com/aws-cloudformation/cloudformation-languageserver/.

Vous avez besoin d'aide ?

Essayez la CloudFormationcommunauté AWS re:Post.