More than 1 year has passed since last update.

めんどうくさそうなAWS Cloudformationの使い方を学ぶ

Posted at 2023-09-22

まえがき

AWS Cloudformationを初めて使用した際のメモを整理し、Cloudformationはめんどくさそうという意識のハードルを下げる内容にまとめました。

AWS Cloudformationの説明

AWSリソースの構築を自動化するサービス。
リソース情報を記載したJSONかYAMLのフォーマットをテンプレートとし、それを読み込ませることで自動的な構築が可能。
Cloudformation自体は無料。構築したリソース自体の料金は別途発生します。

テンプレートから同じ環境を再構成できるのでリソースの構築が簡単です。
同様にリソースの削除も容易にできます。

とりあえず試してみる

テンプレートの準備

AWSドキュメントのCloudFormationユーザーガイド＞テンプレートリファレンス＞ AWS Identity and Access Management ＞ AWS::IAM::User にあるIAMユーザーを作成するテンプレートを参考に作成していきます。
テンプレートのフォーマットはYAMLの方が馴染みがあるので、YAMLで作成します。

iam_user_create_001.yaml
```
Resources:
  MyIAMUser:
    Type: 'AWS::IAM::User'
    Properties:
      UserName: '{my-iam-user}'
```
UserNameの{my-iam-user}には任意の名前を記載するようにします。
とりあえず作成するなら上記の情報だけで良さそうです。
（AWS CloudFormation テンプレートバージョン、Descriptionなど無くても動くものはひとまず無視します。）

Cloudformationの実行

AWSのサービスメニューからCloudformationを選択します。
スタックの作成ボタンからスタックの作成画面に遷移し、各ステップで操作を行います。
なお、スタックはテンプレートから作成された環境群を意味します。
ステップ 1：準備したテンプレートをアップロードします。
ステップ 2：スタックの名前を決めます。
ステップ 3：デフォルトの内容で問題ありません。
ステップ 4：レビューで最終確認をします。送信を押下すると作成が始まります。
（IAMのリソースを作成するにあたり承認が求められます。内容を承認して送信します。）

Cloudformationの完了

作成に成功するとCREATE_COMPLETEとなります。
作成に失敗した場合は以下の状態になります。
- 「状況の理由」に失敗した原因が出力されるので確認します。
- この時は不適当なUserNameを指定したため失敗しています。
- 失敗したテンプレートの内容を変更してスタックの作成からやり直します。（同一のスタック名で再作成する場合は、失敗したスタックを削除します。）

IAMユーザーの確認

ユーザーの作成が確認できました。

パラメータを使ってテンプレートに汎用性を持たせる

とりあえずIAMユーザーを作成することが出来ました。
ですが、先ほどのテンプレートでは、ユーザーを作成する度にテンプレート内のユーザー名の変更が発生します。
そこでCloudformationの実行準備時に設定できるパラメータをテンプレートに記載することで、IAMユーザー作成テンプレートに汎用性を持たせます。

テンプレートセクション

テンプレートは1つ以上のセクションで構成されます。セクションで唯一必須なのが先ほどのテンプレートにも記載したResources:です。
Parameters:はCloudformation実行時 (スタックを作成または更新するとき) にテンプレートに渡す値です。

パラメータを使ったテンプレートの準備

先ほどのIAMユーザー作成のテンプレートにパラメータを追加して、ユーザー名を指定してIAMユーザーを作成できるようにします。

パラメータの詳細についてはAWSドキュメントのCloudFormationユーザーガイド＞テンプレートの操作内＞テンプレートの構造分析＞パラメータを参照してください。

iam_user_create_002.yaml

Parameters:
  # パラメータ名がUserNameParameter　データ型がString
  UserNameParameter: 
    Type: String
Resources:
  MyIAMUser:
    Type: 'AWS::IAM::User'
    Properties:
      # !RefでパラメータのUserNameParameterを参照
      UserName: !Ref UserNameParameter