More than 5 years have passed since last update.

初学者のためのAWS入門(2) CloudFormation入門-1

Last updated at 2019-11-12Posted at 2017-09-02

（2019/09/29 テンプレートで実際に環境を作る際の画面が変更になっているので更新）

初学者のためのAWS入門シリーズ

[初学者のためのAWS入門(1)] (https://qiita.com/mshinoda88/items/e7557227f7060b52d8ae)
初学者のためのAWS入門(2) - CloudFormation入門1 -> この記事です。
[初学者のためのAWS入門(3) - CloudFormation入門2]
(https://qiita.com/mshinoda88/items/65e7e145c7ec943af403)
初学者のためのAWS入門(4) - S3でBasic認証を設定してリポジトリを公開
初学者のためのAWS入門(5) - S3+Athena+QuickSightでデータ分析結果の可視化
初学者のためのAWS入門(6) - Lambdaでサーバレス実行してみる

1. CloudFormation って何？

・AWSリソース（EC2やRDS、S3等）をテンプレート化して自動で構築できる。
・CloudFormation自体は利用無料（利用したインスタンス等のみ料金がかかる）

1-1. テンプレート再利用のメリット

同じテンプレートを使いまわせる。
検証と本番で同じテンプレートを利用することにより、構成を同じにできる。
AWSの構成を可視化出来る。
バージョン管理も出来る。

1-2. CloudFormationの概念

テンプレート

JSON形式で記述する、AWSリソースのパラメータ。
複数のリソースを連携できる（例えば、EC2作成→EIP割り当て等）

スタック

テンプレートによって管理（作成、更新、削除）されるリソースをスタックと言います。
AWSではリソースはスタック単位で管理されます。
スタック作成時にスタックで利用するテンプレートを指定する。

2. CloudFormation 利用時のワークフロー

2-1. 通常利用時のワークフロー

テンプレート作成
ローカルまたはS3へ保存
スタック作成（作成したテンプレートを指定）
自動でプロビジョニングされる

2-2. スタックの更新時のワークフロー

テンプレートの修正
ローカルまたはS3へ保存
更新したテンプレートを指定
変更したリソースのみ更新される

3. 試行環境を準備する

図1 試行環境

以下のような内容のシンプルな環境を作っていきます。

VPC(10.0.0.0/16)を1つ作る。
VPC名は「My-VPC01」とする。
そのサブネット(10.0.1.0/24)を1つ作ります。
サブネット名は「My-Subnet01」とする。
インスタンスがインターネットにアクセスできるようにインターネットゲートウェイを作ります。
ゲートウェイ名は「My-IGW01」とする。
インターネットゲートウェイへのルーティングテーブルを作ります。
ルーティングテーブル名は「My-Route01」とします。

4. 作業の流れ

作業の大まかな流れは次の通り。

環境を定義した「テンプレート」というファイルを作成する。
テンプレートファイルをCloudFormationに読み込ませる。
手順としては以上。

テンプレートはjson形式です。
CloudFormationは、テンプレートを作成することが全てです。

4-1. テンプレートの作成

図1 試行環境の内容を書き起こすと以下のような感じになります。

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  "Resources" : {
    "MyVPC" : {
      "Type" : "AWS::EC2::VPC",
      "Properties" : {
      "CidrBlock" : "10.0.0.0/16",
      "EnableDnsSupport" : "true",
      "EnableDnsHostnames" : "true",
        "InstanceTenancy" : "default",
        "Tags" : [ {"Key" : "Name", "Value" : "My-VPC01"} ]
      }
    },
    "MyIGW" : {
      "Type" : "AWS::EC2::InternetGateway",
      "Properties" : {
        "Tags" : [ {"Key" : "Name", "Value" : "My-IGW01"}]
      }
    },
    "MyAttachGateway" : {
      "Type" : "AWS::EC2::VPCGatewayAttachment",
      "Properties" : {
        "VpcId" : { "Ref" : "MyVPC" },
        "InternetGatewayId" : { "Ref" : "MyIGW" }
      }
    },
    "MySubnet" : {
      "Type" : "AWS::EC2::Subnet",
      "Properties" : {
        "VpcId" : { "Ref" : "MyVPC" },
        "CidrBlock" : "10.0.0.0/20",
        "AvailabilityZone" : "ap-northeast-1a",
        "Tags" : [ { "Key" : "Name", "Value" : "My-Subnet01" } ]
      }
    },
    "MyRouteTable" : {
      "Type" : "AWS::EC2::RouteTable",
      "Properties" : {
        "VpcId" : { "Ref" : "MyVPC" },
        "Tags" : [ { "Key" : "Name", "Value" : "My-Route01" } ]
      }
    },
    "MySubnetAttache" : {
      "Type" : "AWS::EC2::SubnetRouteTableAssociation",
      "Properties" : {
        "RouteTableId" : { "Ref" : "MyRouteTable" },
        "SubnetId" : { "Ref" : "MySubnet" }
      }
    },
    "MyRoute" : {
      "Type" : "AWS::EC2::Route",
      "Properties" : {
        "RouteTableId" : { "Ref" : "MyRouteTable" },
        "DestinationCidrBlock" : "0.0.0.0/0",
        "GatewayId" : { "Ref" : "MyIGW" }
      }
    }
  }
}

全体の構造は以下のようなJSON構造になっており、定義の一塊(リソース)を列挙していく。

{
  "AWSTemplateFormatVersion" : "フォーマットバージョン",
 
  "Description" : "説明文",
 
  "Metadata" : {
    テンプレートのメタデータ
  },
 
  "Parameters" : {
    スタック起動時にテンプレート渡す値
  },
 
  "Mappings" : {
    キーと名前付きの値を対応付け
  },
 
  "Conditions" : {
    入力パラメータによって評価される条件
  },
 
  "Resources" : {
    テンプレート化するAWSリソース（VPC,EC2など）を記載
  },
 
  "Outputs" : {
    リソースを追加、変更、削除する変更時に出力する内容
  }
}

4-2. Resources の設定

Resources にはAWSリソースの列挙をします。

"Resources" : {
    <リソース>,
    <リソース>,...
    <リソース>
}

各リソースは以下のような構造です。
リソースはリソースタイプ毎に作ります。
リソースタイプとは「何を作るか」の種類の指定の事で「Type」で指定します。

<リソースID>:{
   "Type" : "AWS::aws-product-name::data-type-name",
   "Properties" : {
　　　      設定値
    }
}

指定できるリソースタイプの種類は公式ドキュメントのリファレンスに詳しく書かれています。
AWS リソースプロパティタイプのリファレンス

4-3. リソースID(論理ID)

最初の「MyVPC」がこのリソースID(論理ID)になります。
これはリソースの名前のことで、利用可能な文字種は、英数字(A-Za-z0-9)のみ。
テンプレート内で一意であれば任意で良い。

マネジメントコンソールで操作する時は、リソースID を押下して値設定などの操作を
することになります。

4-4. リソースの参照

テンプレートの中にチラホラ出てくる「Ref」の文字ですが、これが先ほど書いた「リソースID」を参照するという意味です。
下記の部分で説明すると「MyVPC」が参照されていますが、参照されるのは
リソース名「MyVPC」で定義されているリソース内容になります。

"MyAttachGateway" : {
  "Type" : "AWS::EC2::VPCGatewayAttachment",
  "Properties" : {
    "VpcId" : { "Ref" : "MyVPC" },
    "InternetGatewayId" : { "Ref" : "MyIGW" }
  }
}

「MyAttachGateway」のリソースでは、
　　インターネットゲートウェイ「MyIGW」に
　　VPC「MyVPC」をアタッチしようとしています。
実際に作成される際は、「MyIGW」「MyVPC」で定義されたリソース内容を参照して作成されることになります。

4-5. テンプレートの記述する順序

テンプレートを書く順番は特には決まっていません。
VPC作ってからサブネット作るという流れに沿って書かなくても、CloudFormation側で内容を解釈して実行してくれます。
しかし、人がメンテしやすいようにある程度順番を意識して書くと、後で見た時にわかりやすい。

4-6. テンプレート記述のまとめ

ここまでの内容でまとめると、以下になります。

論理IDを適当に宣言する。
何を作るのか「リソースタイプ」Typeを指定する。
各Type毎に必要な要素を「Properties」で指定する。
他のリソースの参照が必要な場合は、参照したい論理IDを指定する。

今回のテンプレートの構造は大まかに以下の通り。

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  "Resources" : {
    "MyVPC" : {
      "Type" : "AWS::EC2::VPC",
    },
    "MyIGW" : {
      "Type" : "AWS::EC2::InternetGateway",
    },
    "MyAttachGateway" : {
      "Type" : "AWS::EC2::VPCGatewayAttachment",
    },
    "MySubnet" : {
      "Type" : "AWS::EC2::Subnet",
    },
    "MyRouteTable" : {
      "Type" : "AWS::EC2::RouteTable",
    },
    "MySubnetAttache" : {
      "Type" : "AWS::EC2::SubnetRouteTableAssociation",
    },
    "MyRoute" : {
      "Type" : "AWS::EC2::Route",
    }
  }
}