CloudFormation のための VSCode 環境作成

VSCode で CloudFormation を書くための、vscode のプラグインについてです。

入れてみると、これは必須だなと感じたので、その環境構築方法を備忘録しておきます。

前提
プラグイン
1. CloudFormation
  1. 事前準備
  2. 使い方
2. CloudFormation Linter

前提

OS：Windows 10
VSCode はインストール済み
python3 と pip が使える環境

プラグイン

２つのプラグインを入れました。

それぞれ簡単に説明します。

CloudFormation

そのまんまな名前ですが、以下のようなプラグインです。

このプラグインは、スニペットとして使います。
リソースごとに、「何を記述するんだっけ？」ってなったときにテンプレートを作ってくれるので助かります。

使い方は英語で書いてあるのですが、概要を下記に書きます。（ここでは *.yml で作成することを前提で進めます）

事前準備

CloudFormation は yaml 記法と若干違うところがあるので、vscodeの設定を変えます。
（デフォルトだと、Unresolved tag: !Ref というエラーになる）

設定を開く
検索窓で yaml.customTags と入力し、下記の通りヒットした項目で「settings.json で編集」を選択
yaml.customTags 内に、以下の通り追記する

      "yaml.customTags": [
        "!Base64 scalar",
        "!Cidr scalar",
        "!And sequence",
        "!Equals sequence",
        "!If sequence",
        "!Not sequence",
        "!Or sequence",
        "!Condition scalar",
        "!FindInMap sequence",
        "!GetAtt scalar",
        "!GetAtt sequence",
        "!GetAZs scalar",
        "!ImportValue scalar",
        "!Join sequence",
        "!Select sequence",
        "!Split sequence",
        "!Sub scalar",
        "!Transform mapping",
        "!Ref scalar",
      ],

こちら、以下を参考にしました。

Unresolved tag: !Ref in CloudFormation Template · Issue #669 · redhat-developer/vscode-yaml

##Description When the extension is running and I am creating a CloudFormation template, the valid syntax of !Ref EnvironmentName, for example, where Environmen...

settings.json を保存する
vscode にて CloudFormation をインストールする

使い方

空のファイル（*.yml）を作成する
ファイルの行頭で start と入力する。入力し始めると、スニペットが作動するので、タブボタンを押す
すると、以下のようにスニペットでテンプレートが自動挿入されます（赤波線は後述でインストールしてるlinterの機能なので、このプラグインとは別物です）
各項目配下で、上述のようにスニペットが使えるようになる
- 例えば、Resources 配下で ec2 と入力すると、以下のようにスニペットが作動する
- ここでタブを押すと、以下のようにEC2インスタンスに関するテンプレートが自動挿入される