Vue d'ensemble des modèles

Un AWS CloudFormation le modèle définit le AWS les 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 Resources section, qui doit déclarer au moins une ressource.

• Pour la structure complète du modèle avec toutes les sections disponibles, voirFormats de modèle.

• Pour plus de détails sur chaque section, voirSections de modèle.

Le fichier modèle suit des règles de formatage spécifiques utilisant soit la notation JavaScript d'objet (JSON), soit la YAML norme. JSONest plus verbeux et rigide, tout en YAML étant plus lisible et flexible. Pour de plus amples informations, veuillez consulter Formats de modèle.

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 le S3 URL du modèle au lieu de le télécharger directement.

Si vous importez des modèles directement par le biais du AWS Management Console or AWS CLI, un compartiment S3 est automatiquement créé pour vous. Pour de plus amples informations, veuillez consulter Création d'une pile depuis la CloudFormation console.

Référentiel Git

Avec Git sync, vous pouvez stocker des modèles dans un dépôt 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 à un S3. URL CloudFormation surveille automatiquement le référentiel et la branche spécifiés pour détecter les modifications du modèle.

Validation des modèles

Validation de syntaxe

Vous pouvez vérifier la YAML syntaxe JSON ou la syntaxe de votre modèle à l'aide du validate-templateCLIcommande ou en spécifiant votre modèle sur la console. La console effectue la validation automatiquement. Toutefois, ces méthodes vérifient uniquement la syntaxe de votre modèle et ne valident pas les valeurs de propriété que vous avez spécifiées pour une ressource.

Outils de validation supplémentaires

Pour des validations plus complexes et des contrôles des meilleures pratiques, vous pouvez utiliser des outils supplémentaires tels que :

• CloudFormation Linter (cfn-lint) — Validez les modèles par rapport aux schémas du fournisseur de ressources. Cela inclut la vérification des valeurs valides pour les propriétés des ressources et les meilleures pratiques.

• CloudFormation Rain (rain fmt) : formatez vos CloudFormation modèles selon une norme cohérente ou reformatez un modèle de JSON à YAML (ou YAML àJSON). Il préserve les commentaires lors de son utilisation YAML et fait passer l'utilisation des fonctions intrinsèques à la syntaxe courte dans la mesure du possible.

Commencer à utiliser les modèles

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

1. Choisissez les ressources — Identifiez les AWS les ressources que vous souhaitez inclure dans votre pile, telles que EC2 les instancesVPCs, les groupes de sécurité, etc.

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

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

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

Ressources supplémentaires

• AWS référence aux types de ressources et de propriétésFournit la syntaxe permettant de déclarer les différents types de ressources.

• Les fonctions Référence des fonctions intrinsèques des documents que vous pouvez utiliser pour effectuer des tâches telles que joindre des chaînes ou référencer d'autres ressources dans vos modèles. Les fonctions intrinsèques couramment utilisées sont les suivantes :

  • Ref— Récupère la valeur d'un paramètre ou l'identifiant 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 du modèle.

  • Join— Joint un ensemble de valeurs en une seule chaîne.

• Les attributs spéciaux du Référence d'attribut de ressource document qui peuvent être utilisés, notamment :

  • DependsOn— Utilisez cet attribut pour spécifier qu'une ressource doit être créée après l'autre.

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

  • Metadata— Utilisez cet attribut pour spécifier des données structurées avec une ressource.