Modifiez les modèles visuellement avec Template Studio

Template Studio est un éditeur de modèles intégré à la CloudFormation console. Il affiche votre modèle sous forme de texte à côté d'un diagramme des ressources déclarées par le modèle. Lorsque vous modifiez le modèle, le diagramme est redessiné pour correspondre. Vous pouvez valider le modèle, le convertir entre YAML et JSON et l'enregistrer sur Amazon S3 sans quitter la console.

Le texte du modèle fait autorité. Le diagramme est une représentation visuelle de ce texte, et non une surface modifiable séparée. Vous apportez toutes les modifications au modèle.

Considérations

Gardez les points suivants à l'esprit lorsque vous travaillez dans un studio de modèles :

• Vous créez dans le modèle, pas dans le diagramme. Le diagramme montre les ressources déclarées par votre modèle et la manière dont elles se réfèrent les unes aux autres ; vous ne pouvez pas ajouter ou configurer une ressource en modifiant le diagramme.

• Vos modifications ne sont pas enregistrées automatiquement. Template Studio demande une confirmation avant que vous ne repartiez avec des modifications non enregistrées. Si vous quittez ou actualisez la page, les modifications non enregistrées sont ignorées. Enregistrez sur Amazon S3, ou copiez ou téléchargez le modèle avant de partir.

• La conversion d'un modèle de YAML en JSON supprime ses commentaires, car le JSON n'a pas de syntaxe pour eux. La reconversion en YAML ne les restaure pas.

• CloudFormation la validation dans Template Studio n'est actuellement pas disponible pour les brouillons de plus de 51 200 octets (50 KiB). L'action Valider en cours envoie le brouillon via le TemplateBody paramètre, qui a cette limite. Il ne s'agit pas de la limite globale de taille du modèle. Vous pouvez toujours enregistrer le modèle et l'utiliser dans une opération de pile, sous réserve de CloudFormation quotas. Pour plus d'informations, consultez la section Valider un modèle.

• L'enregistrement enregistre le modèle dans un compartiment de votre compte, de sorte que les modèles que vous enregistrez sont facturés aux tarifs standard d'Amazon S3. Pour plus d’informations, consultez Tarification Amazon S3.

• Vous pouvez télécharger le diagramme des ressources uniquement lorsque le canevas est affiché dans la vue Canevas ou dans les deux vues.

Autorisations requises pour le studio de modèles

Les autorisations dont vous avez besoin dépendent de la source du modèle et des actions que vous effectuez :

cloudformation:GetTemplate

Nécessaire pour ouvrir le modèle d'une pile existante. Accordez l'accès à la pile dont vous souhaitez modifier le modèle.

s3:GetObject

Nécessaire pour lire un modèle depuis Amazon S3 à l'aide de vos informations d'identification. Accordez l'accès à l'objet du modèle source. Une URL présignée utilise l'autorisation incluse dans l'URL.

cloudformation:ValidateTemplate

Obligatoire pour choisir Valider.

s3:PutObject

Nécessaire pour enregistrer un modèle. Étendez cette autorisation aux objets du compartiment de destination, par exemplearn:aws:s3:::destination-bucket/*, plutôt qu'à toutes les ressources.

s3:CreateBucket

Obligatoire uniquement lorsque la console crée un compartiment de destination manquant. Il peut s'agir du bucket géré par la console ou d'un nom de bucket que vous spécifiez. La réutilisation d'un bucket existant ne nécessite pas cette autorisation.

s3:ListBucket

Obligatoire lors de l'enregistrement dans un compartiment existant que vous spécifiez. Template Studio HeadBucket l'utilise pour vérifier l'accès, le propriétaire attendu du bucket et le bucket Région AWS avant le téléchargement.

Pour le bucket géré par la console, cette autorisation est facultative. Sans cela, la boîte de dialogue de sauvegarde affiche toujours le nom du bucket. La sauvegarde nécessite s3:PutObject et, si le bucket doit être créé,s3:CreateBucket.

Ouvrez un studio de modèles

L'endroit d'où vous ouvrez Template Studio détermine dans quel format il s'ouvre et ce qui se passe une fois que vous l'avez enregistré.

Pour créer un nouveau modèle

1. Ouvrez la console CloudFormation .

2. Dans la barre de navigation en haut de l'écran, choisissez le type dans Région AWS lequel vous souhaitez effectuer le déploiement.

3. Dans le volet de navigation, choisissez Template studio.

Pour créer un modèle lors de la création d'une pile

1. Sur la page Create stack, choisissez Build with template studio.

2. Créez le modèle, puis choisissez Enregistrer et continuer.

3. L'assistant de compilation continue avec le modèle que vous avez enregistré, vous n'avez donc pas à le télécharger séparément.

Pour modifier le modèle d'une pile existante

1. Sur la page Stacks, choisissez le nom de la pile.

2. Mettez à jour la pile directement ou créez un ensemble de modifications.

3. Sur la page Préparer le modèle, choisissez Ouvrir dans le studio de modèles. Le modèle actuel de la pile s'ouvre.

4. Choisissez Enregistrer et continuer pour revenir à l'ensemble de mises à jour ou de modifications avec votre modèle modifié.

Ailleurs dans la console, partout où un modèle est affiché, vous pouvez choisir Ouvrir dans le studio de modèles pour travailler dessus.

Travaillez avec le modèle et le diagramme

Template Studio s'ouvre avec le modèle et le diagramme côte à côte. Utilisez le contrôle d'affichage pour choisir ce qui s'affiche à l'écran :

Modèle

Le modèle uniquement, en pleine largeur. Utilisez-le pour lire ou écrire un modèle sans le diagramme.

Canevas

Le schéma uniquement, sur toute sa largeur. Utilisez-le pour un modèle de grande taille où le diagramme nécessite toute la largeur.

Les deux

Le modèle et le schéma réunis. Faites glisser le séparateur entre les deux pour donner plus d'espace à chaque côté.

Le diagramme regroupe les ressources associées et établit une connexion chaque fois qu'une ressource fait référence à une autre via RefFn::GetAtt,Fn::Sub, ouDependsOn. Une ressource à laquelle rien ne fait référence apparaît d'elle-même, ce qui permet de repérer facilement une ressource accidentellement déconnectée.

Note

Par exemple, trois fonctions peuvent assumer le même rôle IAM. Le diagramme montre le rôle au sein de chaque fonction, mais le modèle ne déclare qu'un seul rôle. Consultez le modèle pour voir combien de ressources existent.

Convertir entre YAML et JSON

Le format dans lequel vous enregistrez détermine le nom de fichier et le type de contenu de l'objet que Template Studio écrit sur Amazon S3.

Pour convertir le modèle que vous êtes en train de modifier

1. Choisissez le contrôle de format, qui nomme le format dans lequel vous vous trouvez actuellement.

2. Choisissez l'autre format.

3. La conversion de YAML en JSON vous demande de confirmer, car les commentaires ne peuvent pas être transférés. Choisissez Convertir pour continuer.

Important

Le format JSON ne contient aucune syntaxe pour les commentaires. Lorsque vous convertissez un modèle YAML contenant des commentaires au format JSON, ces commentaires sont supprimés et la reconversion au format YAML ne les restaure pas. Copiez tout ce que vous voulez conserver avant de procéder à la conversion.

Le contrôle de format n'est pas disponible tant que le modèle ne peut pas être lu, car il n'y a rien de suffisamment complet pour être converti. Corrigez d'abord le modèle.

Problèmes de syntaxe lors de la saisie

L'éditeur vérifie la syntaxe du modèle pendant que vous l'écrivez et souligne ce qu'il ne peut pas lire : un crochet non fermé, un retrait mal placé, une clé dupliquée. Survolez un soulignement avec le pointeur pour voir le problème. Lorsqu'une ligne présente plusieurs problèmes, ils sont numérotés afin que vous puissiez les différencier.

Il s'agit d'une vérification de la syntaxe du modèle, et non de son contenu. L'éditeur ne sait pas quels types de ressources existent ni quelles propriétés ils possèdent. Un modèle YAML parfaitement formé peut donc toujours être erroné d'une manière que seul CloudFormation peut vous le signaler. Choisissez Valider pour cela.

Valider un modèle

La validation vérifie la syntaxe du modèle avec l'éditeur et vérifie le modèle avec CloudFormation avant de l'utiliser dans une opération de pile. Les deux vérifications utilisent le brouillon actuel, y compris les modifications que vous n'avez pas enregistrées. Une CloudFormation vérification réussie ne remplace pas les erreurs de syntaxe signalées par l'éditeur.

Note

Template Studio envoie le brouillon à l'ValidateTemplateAPI à l'aide du TemplateBody paramètre. Ce paramètre est limité à 51 200 octets (50 KiB).

Pour un brouillon supérieur à cette limite, Template Studio n'envoie pas la CloudFormation demande. Le CloudFormation chèque n'est pas disponible, mais cela ne signifie pas que le modèle n'est pas valide. L'éditeur peut toujours signaler des erreurs de syntaxe.

La même API prend en charge les modèles d'une taille maximale de 1 MoTemplateURL. Template Studio ne télécharge pas les brouillons modifiés à des fins de URL-based validation. Vous pouvez enregistrer le modèle sur Amazon S3 et le valider par le biais d'une opération de stack, sous réserve de CloudFormation quotas.

Pour valider le modèle que vous êtes en train de modifier

1. Choisissez Valider.

2. Un modèle qui passe les deux vérifications est signalé comme valide.

3. Si l'une des vérifications détecte des erreurs, vérifiez-les dans le message de validation. Les erreurs de l'éditeur incluent les numéros de ligne et de colonne. Corrigez les erreurs dans l'éditeur et validez à nouveau.

Enregistrer un modèle sur Amazon S3

CloudFormation lit les modèles pour les opérations de stack depuis Amazon S3. C'est donc grâce à l'enregistrement que votre modèle est accessible au reste de la console.

Utilisez des références dynamiques aux secrets stockés dans Secrets Manager ou des chaînes sécurisées dans le magasin de paramètres Systems Manager au lieu d'inclure des secrets en texte brut dans les modèles enregistrés. Pour plus d’informations, consultez Obtenir les valeurs stockées dans d’autres services à l’aide de références dynamiques.

Pour enregistrer le modèle que vous êtes en train de modifier

1. Choisissez Save and continue (Enregistrer et continuer).

2. Vérifiez la destination. Par défaut, le modèle est transféré dans le compartiment Amazon S3 qui CloudFormation gère les modèles téléchargés dans le compartiment actuel Région AWS. Si ce compartiment n'existe pas encore, CloudFormation créez-le lorsque vous l'enregistrez et réutilisez-le pour les modèles que vous enregistrerez ultérieurement.

   1. Pour choisir votre propre destination, choisissez Utiliser un compartiment différent et entrez un nom de compartiment. Le bucket est créé s'il n'existe pas déjà.

3. Choisissez Confirmer et continuez.

Note

Les modèles stockés dans Amazon S3 sont facturés aux tarifs standard d'Amazon S3, quel que soit le compartiment qui les contient. Pour plus d’informations, consultez Tarification Amazon S3.

L'enregistrement ne nécessite pas de résultat de validation réussi. Lorsque la validation détecte des erreurs, Template Studio vous demande de confirmer que vous souhaitez tout de même enregistrer. L'enregistrement ne corrige pas ces erreurs. Passez en revue et corrigez-les avant d'utiliser le modèle dans le cadre d'une opération de pile.

Copier ou télécharger un modèle ou un diagramme

Choisissez les actions du modèle pour retirer le modèle ou le diagramme de la console :

Copier le modèle

Copie le modèle tel qu'il apparaît dans l'éditeur dans votre presse-papiers.

Téléchargez le modèle

Enregistre le modèle sous forme de fichier, dans le format dans lequel vous êtes en train de le modifier.

Télécharger le schéma des ressources

Enregistre le diagramme sous forme d'image PNG. L'image étant une capture du diagramme, elle n'est disponible que lorsque le diagramme est affiché à l'écran.