subtitle

RaiseTechの各種コースをはじめとしたイロイロな学習の記録

VSCodeにCloudFormationのスニペットを導入

CloudFormationのテンプレートを作りやすくするために、VSCodeにスニペットをインストールする。

VSCodeで「CloudFormation」と検索すれば、インストールできるものが表示されるので、必要なものをインストール。



AWS CloudFormationのスニペットを入れると、必要事項が自動で入る。

いちいち確認しながら手入力、というのはナンセンスなので、とてもありがたい機能。



unknown tag <!Ref>エラー回避策

CloudFormationのテンプレートをVSCodeを使ってYAMLで書こうとすると、参照「!Ref」でエラーが出る。

unknown tag <!Ref>

どうやら、!Ref はCloudFormation特有の書き方らしく、この書き方に対応できていないことが原因らしい。


VSCodeには、settings.jsonというファイルがあって、そこでワークスペースの設定が色々できるらしい。

今回の件も然り。

ファイル > ユーザー設定 > 設定


画面の右側のファイルアイコンをクリックして、settings.jsonを開く


settings.jsonの{}の中に、カスタムタグの定義を追加


すでに、何かしらの定義がしてある場合は、前の定義の後ろにカンマを打ってから、下記のコードをコピペ。

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


保存すれば、すぐに反映されて、エラーが出なくなる。