PR

CloudFormationの構文をチェックする – デプロイ失敗連発の沼にハマらないために

tips TIPS

CloudFormation便利ですよね。使えないと仕事にならないくらいの基本スキルとなってきました。
ただ、凄腕エンジニアでない私は結構な頻度で失敗します。そして沼にハマると抜け出せません。

そんな私の救世主となるのが、構文チェックツールです。目視でチェックするだけでは見落としがちな構文チェックをしてくれる頼もしい味方たちです。

CloudFormationに苦手意識をお持ちの方、チェックしてみてくださいね。

Amazon CloudFormation Liner

  • 取得先
    https://github.com/aws-cloudformation/cfn-lint
  • 要件
    • Python 3.8以上

インストール方法

% python -V
Python 3.9.13


% pip install cfn-lint
Collecting cfn-lint
  Downloading cfn_lint-1.9.3-py3-none-any.whl (4.4 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4.4/4.4 MB 5.0 MB/s eta 0:00:00
Collecting jsonpatch
<以下略>

Homebrewでも入るみたいです

brew install cfn-lint

使い方

テンプレートを引数に渡すだけ

% cfn-lint template.yml

各種エディタにも対応しているので、詳細はGitHubのREADME.mdを参照してみてください！素敵に美しくまとまっているので、とてもわかりやすいです！

Validation Template

AWS CLIでも構文チェックは可能です。

  • valdation-template
    https://docs.aws.amazon.com/cli/latest/reference/cloudformation/validate-template.html
  • 要件
    • AWS CLI

使い方

aws cloudformation validate-template --template-body file://sampletemplate.json

まとめ

今回は2つのツールを紹介させていただきました。時間短縮のためにCloudFormationを使っているのに、構文エラーでどハマりしていたら本末転倒ですよね。
ツールを活用してCloudFormationマスターを目指しましょう！