CloudFormationテンプレート作成を効率化するスニペットツール-さとゆうのブログ

やりたいこと

今回はCloudFormation(以降Cfn)のスニペットツールを紹介していきます。
利用するのはVSCodeの拡張機能で「CloudFormation Snippets」です。
こちらはCfnのテンプレートを一から作成する際、非常に便利でリソースの定義などを簡潔にしてくれます。

概要

「CloudFormation Snippets」をインストールすることで、Cfnテンプレートを簡潔に記載することができるようになります。なお、対応形式はYAMLですのでJSONで書きたい方向けではありません。自分としてはJSONよりYAMLのほうが見やすくかつ書きやすいため、初めてCfnテンプレートを書く人にはYAMLでの記述を推奨します。

■補足
下記画像のVSCode拡張機能で似たスニペットツールの「CloudFormation」がありますが、こちらのツールは最終更新が2019/11/15(2022/4/10の記事執筆時点)で止まっており、最新のリソースやパラメータが反映されないため、過不足分はAWSドキュメントを参照する必要が出てくるので自分は非推奨です。

使い方

VSCodeの拡張機能検索で「CloudFormation Snippets」をインストールします。
記載するCFnテンプレートファイル(.yml)を用意する
こちらは空のファイルで大丈夫です。
ymlファイル内で「cfn」と入力し、Tabを押すことでテンプレートの基本フォーマットが用意される。
「cfn」と入力した段階で上記の候補が出てきますが、Tabを押すと「cfn」が選択されます。なお、「cfn-lite」を選択することで「cfn」より簡潔なフォーマットが用意されます。
リソース名を入力し、Tabを押して必要な定義を選択する。
■例1：parameters
「parameter」と入力し、Tabを押す。その他候補として選択可能なパラメータ定義があるので、都度定義に必要なものを選択してください。
■例2：Resources(ec2インスタンス)
「ec2-instance」と入力し、Tabを押す。
(補足)各定義で必要とされる値をAWSドキュメントから確認する。
各定義で必須な値と任意の値があるため、AWSドキュメントで確認しましょう。それぞれのサービスについては下記から確認できます。(ブックマーク推奨です！)
AWS リソースおよびプロパティタイプのリファレンス
「Required: Yes」については必須の値となります。