View a markdown version of this page

Utilisation de CloudFormation modèles - AWS CloudFormation
Où sont stockés les modèlesValidation des modèlesPremiers pas avec les modèlesExemples de modèle

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.

Utilisation de CloudFormation modèles

Un AWS CloudFormation modèle définit les AWS ressources que vous souhaitez créer, mettre à jour ou supprimer dans le cadre d'une pile. Il se compose de plusieurs sections, mais la seule section obligatoire est la section Resources, qui doit déclarer au moins une ressource.

Vous pouvez créer des modèles à l’aide des méthodes suivantes :

  • Studio de modèles : modifiez les modèles et visualisez leurs ressources dans un diagramme visuel.

  • Éditeur de texte : écrivez des modèles directement dans la syntaxe JSON ou YAML.

  • Générateur IaC : générez des modèles à partir des ressources fournies dans votre compte qui ne sont pas actuellement gérées par CloudFormation. Le générateur IaC fonctionne avec un large éventail de types de ressources pris en charge par l’API Cloud Control dans votre région.

Cette section fournit un guide complet expliquant comment utiliser les différentes sections d'un CloudFormation modèle et comment commencer à créer des modèles de pile. Elle couvre les rubriques suivantes :

Rubriques

Où sont stockés les modèles

Compartiment Amazon S3

Vous pouvez stocker CloudFormation des modèles dans un compartiment Amazon S3. Lorsque vous créez ou mettez à jour une pile, vous pouvez spécifier l’URL S3 du modèle au lieu de le charger directement.

Si vous chargez des modèles directement via le Console de gestion AWS ou AWS CLI, un compartiment S3 est automatiquement créé pour vous. Pour plus d’informations, consultez Création d'une pile à partir de la CloudFormation console.

Référentiel Git

Avec Git sync, vous pouvez stocker des modèles dans un référentiel Git. Lorsque vous créez ou mettez à jour une pile, vous pouvez spécifier l'emplacement du dépôt Git et la branche contenant le modèle au lieu de le télécharger directement ou de faire référence à une URL S3. CloudFormation surveille automatiquement le référentiel et la branche spécifiés pour détecter les modifications du modèle. Pour plus d’informations, consultez Créez une pile à partir du code source du référentiel avec la synchronisation Git.

Validation des modèles

Validez vos modèles avant le déploiement afin de pouvoir détecter et résoudre les problèmes plus tôt. Le CloudFormation service et les outils présentés dans cette section vérifient les différentes parties d'un modèle. Vous pouvez les utiliser ensemble.

Vous pouvez vérifier si un modèle utilise du JSON ou du YAML valide à l'aide de la commande validate-templateCLI ou en spécifiant votre modèle dans le Console de gestion AWS. La console effectue cette vérification automatiquement. Ces contrôles côté service n'exécutent pas les contrôles supplémentaires relatifs aux propriétés, à la sécurité ou aux meilleures pratiques fournis par les outils suivants :

  • CloudFormation Serveur de langues— Obtenez des suggestions, de la documentation et des commentaires de validation lorsque vous rédigez des modèles dans un éditeur.

  • CloudFormation Linter— Vérifiez les propriétés des ressources, les valeurs autorisées et les problèmes courants à partir de la ligne de commande, d'un éditeur ou d'une version automatisée.

  • CloudFormation Valider— Exécutez des vérifications locales et hors ligne à partir de la ligne de commande ou d'une bibliothèque, et ajoutez des règles personnalisées dans Common Expression Language (CEL), Rego ou Guard. AWS CDK utilise ce validateur automatiquement après avoir synthétisé vos modèles.

  • CloudFormation Guard— Rédigez des règles de politique et vérifiez les modèles par rapport aux exigences de sécurité, de conformité et de gouvernance de votre organisation.

Utilisation avec des agents de codage AI

Les agents de codage basés sur l'IA peuvent vous aider à créer, à valider et à dépanner des CloudFormation modèles en utilisant les aws-cloudformation compétences du kit d'outils des agents pour AWS le GitHub reste. Pour obtenir des instructions d’installation, consultez Guide de configuration de l'agent.

Comprendre le périmètre de validation

Les outils locaux vérifient le modèle et les règles que vous leur donnez. Ils ne peuvent pas garantir le succès du déploiement avec les ressources, les autorisations et les quotas actuels Région AWS. Compte AWS Avant le déploiement, passez en revue un ensemble de modifications et corrigez les éventuels problèmes signalés par le CloudFormation service.

Premiers pas avec les modèles

Pour commencer à créer un CloudFormation modèle, procédez comme suit :

  1. Choisissez les ressources : identifiez les AWS ressources que vous souhaitez inclure dans votre pile, telles que les instances EC2, les VPC, les groupes de sécurité, etc.

  2. Rédiger le modèle : rédigez le modèle au format JSON ou YAML, en définissant les ressources et leurs propriétés.

  3. Enregistrer le modèle : enregistrez le modèle localement avec une extension de fichier telle que : .json, .yaml ou .txt.

  4. Valider le modèle : validez le modèle à l’aide des méthodes décrites dans la section Validation des modèles.

  5. Créer une pile : créez une pile à l’aide du modèle validé.

Prévoyez d'utiliser la référence du CloudFormation modèle

Lorsque vous rédigez vos modèles, vous pouvez trouver la documentation relative à la syntaxe détaillée des différents types de ressources dans la Référence des types de ressources et de propriétés AWS.

Souvent, vos modèles de pile nécessiteront des fonctions intrinsèques pour attribuer des valeurs de propriété qui ne sont pas disponibles avant l’exécution et des attributs spéciaux pour contrôler le comportement des ressources. Lorsque vous rédigez votre modèle, veuillez vous référer aux ressources suivantes pour obtenir des conseils :

  • Référence des fonctions intrinsèques : voici quelques fonctions intrinsèques couramment utilisées :

    • Ref : récupère la valeur d’un paramètre ou l’ID physique d’une ressource.

    • Sub : remplace les espaces réservés dans les chaînes par des valeurs réelles.

    • GetAtt : renvoie la valeur d’un attribut d’une ressource dans le modèle.

    • Join : joint un ensemble de valeurs dans une seule chaîne.

  • Référence des attributs de ressource : voici quelques attributs spéciaux couramment utilisés :

    • DependsOn : utilisez cet attribut pour spécifier qu’une ressource doit être créée après une autre.

    • DeletionPolicy— Utilisez cet attribut pour spécifier CloudFormation comment gérer la suppression d'une ressource.

Exemples de modèle

CloudFormation fournit des modèles de stack open source que vous pouvez utiliser pour démarrer. Pour plus d'informations, consultez la section CloudFormation Exemples de modèles sur GitHub.

Veuillez noter que ces modèles ne sont pas destinés à être utilisés en production. Il est recommandé de prendre le temps de comprendre leur fonctionnement, de les adapter à vos besoins et de vous assurer qu’ils répondent aux normes de conformité de votre entreprise.

Chaque modèle de ce référentiel passe les tests CloudFormation Linter (cfn-lint), ainsi qu'un ensemble de AWS CloudFormation Guard règles de base basé sur le Center for Internet Security (CIS) Top 20, à l'exception de certaines règles pour lesquelles il était logique de concentrer l'échantillon sur un seul cas d'utilisation.