CloudFormation　テンプレートの書き方と関連ツール

Last updated at 2023-09-21Posted at 2023-09-21

CloudFormationはプログラミング言語やテキストファイルを使用してAWSリソースを自動で構築するサービスです。
テンプレートのセクションや関連したツールをまとめました。

テンプレートとスタック

テンプレートはAWSリソースを構築する設計図のようなものです。
スタックと呼ばれる単一のユニットとしてリソースを管理します。スタックを作成、更新、削除することでリソースのコレクションを作成、更新、削除します。
以下の例のように記述します。

AWSTemplateFormatVersion: 2010-09-09
Description: A sample template
Resources:
  MyEC2Instance:
    Type: 'AWS::EC2::Instance'
    Properties:
      ImageId: ami-0ff8a91507f77f867
      InstanceType: t2.micro
      KeyName: testkey
      BlockDeviceMappings:
        - DeviceName: /dev/sdm
          Ebs:
            VolumeType: io1
            Iops: 200
            DeleteOnTermination: false
            VolumeSize: 20

テンプレートの書き方

テンプレートはjsonまたはyamlで記述します。
Resource オブジェクトのみ必須項目となります。

Parameters

パラメータを使用するとスタックを作成、更新する際にテンプレートにカスタム値を入力できる。
またFn::Ref(!Ref)を使用してparametersの値を参照できる。NoEchoプロパティをtrueにして設定しておくとパラメータ値はコンソールに表示されない。

Parameters:
  InstanceTypeParameter:
    Type: String
    Default: t2.micro
    AllowedValues:
      - t2.micro
      - m1.small
      - m1.large
    Description: Enter t2.micro, m1.small, or m1.large. Default is t2.micro.
  MyPassword:
    Type: String
    NoEcho: true

パラメータ

疑似パラメータ

疑似パラメータはAWS CloudFormationにより事前に定義されたパラメータで、パラメータと同じようにRef関数の引数として使用する。

Reference Value	Description	Example Returned Value
AWS::AccountId	スタックが作成されるアカウントのIDを返す	123456789
AWS::Region	リソースが作成されているリージョン	us-east-1
AWS::StackId	スタックのID	arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/1f28gqfo834fv
AWS::StackName	スタックの名前	MyStack
AWS::NotificationARNs	スタックの通知ARNリストを返す	[aen:aws:sns:us-east-1:123456789:MyTopic]
AWS::NoValue	`Fn::If`の戻り値として指定すると対応するリソースプロパティを削除する	返り値無し
AWS::Partition	リソースがあるパーティションを返す	標準のリージョンの場合 ->aws
AWS::URLSuffix	ドメインサフィックスを返す	amazonaws.com

Resources

Resourcesは必須項目でCloudFormationテンプレート内で作成するAWSリソースの定義を記述する。具体的には、各リソースのタイプ、プロパティ、およびリソース間の関係を指定する。

リソースはリソースタイプごとに作成しTypeを指定する。具体的な設定はPropertiesで指定していく。

リソース属性

DependsOn 指定したリソースが作成されてからリソースを作成する
DeletionPolicy スタック削除時に削除するか保持するかなどを指定
UpdatePolicy 特定のリソースでCloudFormationが処理する方法を指定できる
UpdateReplacePolicy スタックアップデートする際にリソースを作り直すかそのままにするか
CreationPolicy 指定数のシグナルを受信するかタイムアウトになるまで作成完了ステータスにならないようにする
Metadata 構造化データを関連付ける

Resources:
  MyEC2Instance:
    Type: AWS::EC2::Instance
    Properties:
      ImageId: ami-12345678
      InstanceType: t2.micro
      KeyName: my-key-pair

  MyS3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: my-bucket
      AccessControl: Private

リソース

Mappings

リソースのプロパティや条件に基づいて値をマッピングするために使用される。

Fn::FindInMap関数を使用して値を使用できる。
!FindInMap [MapName, TopLevelKey, SecondLevelKey]

Mappings:
  RegionMap:
    us-east-1:
      AMI: ami-0123456789abcdef0
    us-west-2:
      AMI: ami-abcdef0123456789

Resources:
  myEC2Instance:
    Type: "AWS::EC2::Instance"
    Properties:
      ImageId: !FindInMap [RegionMap, !Ref "AWS::Region", AMI]
      InstanceType: m1.small

マッピング

Outputs

他のスタックでインポートして使用できる値を宣言する。

Outputs:
  StackSSHSecurityGroup:
    Description: The SSH Security Group for our company
    Value: !Ref MyCompanyWideSSHSecurityGroup
    Export:
      Name: SSHSecurityGroup

他のテンプレートで参照したいときは !ImportValue エクスポート名で参照できる。

Resources: 
  WebServer:
    Type: AWS::EC2::Instance
    Properties:
      KeyName: !Ref KeyName
      ImageId: !Ref EC2AMIId
      InstanceType: t2.micro
      SubnetId: !ImportValue SubnetName
      SecurityGroupIds:
        - !ImportValue StackSSHSecurityGroup
      Tags:
        - Key: Name
          Value: WebServer

アウトプット

Condition

条件を作成し条件分岐によりtrueのときのみリソースや出力を作成するようにできる。

以下の例の場合、EnvTypeがprodならtrueとなりVolumeがインスタンスにアタッチされる。

Conditions:
  CreateProdResources: !Equals [ !Ref EnvType, prod ]

Resources:
  EC2Instance:
    Type: AWS::EC2::Instance

  MountPoint:
    Type: AWS::EC2::VolumeAttachment
    Condition: CreateProdResources
    Properties:
      InstanceId: !Ref EC2Instance

!Equals以外の組み込み条件関数はこちらを参照(条件関数)

コンディション

Rules

スタックを作成したりアップデートする際に、テンプレートに送信されたパラメータまたはパラメータの組み合わせを検証する。ルール固有の組み込み関数を使用して、ルール条件とアサーションを定義できる。

次の例ではEnvironmentの値がprodかdevで別のインスタンスを作成するようにしている。

Parameters:
  InstanceType:
    Type: String
    Default: t2.small
    AllowedValues:
      - t2.nano
      - t2.micro
      - t2.small

  Environment:
    Type: String
    Default: dev
    AllowedValues:
      - dev
      - prod
      
Rules:
  ProdInstanceType:
    RuleCondition: !Equals 
      - !Ref Environment
      - prod
    Assertions:
      - Assert:
          !Equals [t2.small, !Ref InstanceType]
        AssertDescription: 'For a production environment, the instance type must be t2.small'

  DevInstanceType:
    RuleCondition: !Equals 
      - !Ref Environment
      - dev
    Assertions:
      # Assert with Or
      # - Assert:
      #     'Fn::Or':
      #       - !Equals [!Ref InstanceType, t2.nano]
      #       - !Equals [!Ref InstanceType, t2.micro]
      # Assert with Contains
      - Assert:
          'Fn::Contains':
            - - t2.nano
              - t2.micro
            - !Ref InstanceType
        AssertDescription: 'For a development environment, the instance type must be t2.nano or t2.micro'

ルール
 ルール関数

Metadata

Metadataセクションではテンプレートの詳細を提供する任意のJSONまたはYAMLオブジェクトを含めることができる。

Metadata:
  Instances:
    Description: "Information about the instances"
  Databases: 
    Description: "Information about the databases"

CloudFormation固有のメタデータキーも存在する。

AWS::Cloudformation::Init cfn-initヘルパースクリプトの構成タスクを定義。AWS::CloudFormation::Init
AWS::CLoudFormation::Interface コンソールに表示される場合の入力パラメータのグループ化と順序を定義する。
AWS::CloudFormation::Designer CloudFormationデザイナーでリソースがどのように配置されるかの情報
AWS::CloudFormation::Authentication AWS::Cloudformation::Initで指定したファイルまたはソースの認証情報を指定する。AWS::CloudFormation::Authentication

AWS::Cloudformation::InitとUserDataの違いはUserDataの場合はコマンドの成否はスタックの成否に影響せずコマンドが失敗してもスタックは成功ステータスになる。反対にcfn-initはcfn-signalと組み合わせることで定義したコマンドの実行成否はスタックの成否に影響するようになる。

メタデータ

Outputs

他のスタックにエクスポートするに利用され出力値を宣言する。

最大で200個まで宣言できvalueが必須となる

Outputs:
  SSHGroupId:
    Value: !Ref SSHSecurityGroup
    Description: Id for the SSH Security Group

インポートする側

Resources:
  EC2Instance:
    Type: AWS::EC2::Instance
    Properties:
      InstanceType: t2.micro
      ImageId: !Ref ImageId
      SecurityGroupIds:
        - !GetAtt SSHSecurityGroupStack.Outputs.SSHGroupId

出力

Custom Resources

テンプレートにカスタムのプロビジョニングロジックを記述しユーザーがスタックを作成、更新、削除するたびにCloudFormationがそれを実行する。
例えばCloudFormationのリソースタイプとして使用できないリソースを含める必要がある場合、カスタムリソースを使用して含めることができる。

カスタムリソースの仕組み
template developerがカスタムリソースとサービストークンを含むテンプレートを作成する。テンプレートを使用してカスタムリソースを使用するたびにCloudFormationは指定のサービストークンに要求を送信する。
LambdaやAmazon SNSのリソースプロバイダがリクエストを処理し、SUCCESSまたはFAILEDの応答を署名付きURLに返す。また応答をJSONでS3URLにアップロードする

SUCCESSを取得した場合CloudFormationはスタック操作を続ける。

// リクエスト
{
   "RequestType" : "Create",
   "ResponseURL" : "http://pre-signed-S3-url-for-response",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/stack-name/guid",
   "RequestId" : "unique id for this create request",
   "ResourceType" : "Custom::TestResource",
   "LogicalResourceId" : "MyTestResource",
   "ResourceProperties" : {
      "Name" : "Value",
      "List" : [ "1", "2", "3" ]
   }
}
// レスポンス
{
   "Status" : "SUCCESS",
   "PhysicalResourceId" : "TestResource1",
   "StackId" : "arn:aws:cloudformation:us-west-2:123456789012:stack/stack-name/guid",
   "RequestId" : "unique id for this create request",
   "LogicalResourceId" : "MyTestResource",
   "Data" : {
      "OutputName1" : "Value1",
      "OutputName2" : "Value2",
   }
}

カスタムリソース

Dynamic Reference

動的な参照を使用することでSystems ManagerパラメータストアやAWS Secrets Managerなどのほかのサービスで管理されている値をテンプレートに指定できる。(最大60個まで)

次のパターンのように記述する
{{resolve:service-name:reference-key}}または{{resolve:ssm:[a-zA-Z0-9_.\-/]+(:\d+)?}}

動的な参照

Modules

CloudFormationのテンプレートをCloudFormationレジストリに登録して別のテンプレートで再利用する機能。
cfn initでひな形の作成。fragmentsディレクトリ配下のsample.jsonをリネームしJSON形式テンプレートを記述し、cfn submitしてレジストリに登録する。

別のテンプレートからはMyCompany::s3::bucket::MODULEのような形で参照することができる

デザイナー

テンプレートを作成するためのグラフィックツール。リソースを可視化でき、ドラッグアンドドロップインターフェイスを使用してテンプレートリソースを図示し更新できる。

ドリフト

スタックでドリフト検出オペレーションを実行するとスタックが予想されるテンプレート構成からドリフトしたかどうかが判断され、ドリフト検出をサポートするスタック内の各リソースのドリフトステータスに関する詳細情報が返される。
　　
スタックの詳細画面でドリフトの検出をすることで使用できる。

StackSets

スタックセットでは1つのテンプレートで複数のリージョンのAWSアカウントにスタックを作成できる。スタックセットを定義したら、指定したターゲットアカウントやリージョンでスタックを作成、更新、削除できる

StackSetsでは複数アカウントのスタックを管理する管理アカウントが存在し、そのアカウントからターゲットアカウントに対してスタックの操作の命令を実行する。

Macros

Lambda関数を使用してテンプレートの記法を拡張できる機能。

マクロの定義の作成

Type: "AWS::CloudFormation::Macro"
Properties:
  Description: String
  FunctionName: String
  LogGroupName: String
  LogRoleARN: String
  Name: String　// リージョン内でユニーク

CloudFormationのマクロ機能でLambda関数と一緒にCloudWatch LogsのLog Groupを自動作成してみる
 マクロ

Resource Types

サードパーティーのリソースをテンプレートで使えるようにする。

リソースタイプ

Rain

AWS CloudFormation のコマンドラインツール。進捗がわかるなどAWS CLIのちょっと辛い部分をカバーしてくれる。

rain

Functions

Fn::Ref 指定したパラメータまたはリソース(id)の値を返す
Fn::GetAtt リソースから属性の値を返す
Fn::FindInMap Fn::FindInMap: [ MapName, TopLevelKey, SecondLevelKey ] Mappingsセクションで宣言されたキーに対応する値を返す
Fn::ImportValue 別のスタックでエクスポートされた出力の値を返す
Fn::join 一連の値を特定の区切り文字で区切って値に追加する(!Join [":",[a,b,c]] => "a : b : c")
Fn::Base64 入力文字列をBase64表現で返す
Fn::Cidr アドレスブロックのCIDRを返す。!Cidr [ ipBlock, count, cidrBits ]
Fn::GetAZs 指定したリージョンのアベイラビリティーゾーンをアルファベット順にリストした配列で返す
FnSelect オブジェクトのリストから 1 つの値を返す。!Select[index, listOfObjects]
Fn::Split 文字列をリストに分割する
Fn::Length 配列の要素数を返す
Fn::Sub 入力文字列の変数を指定した値に置き換える
Fn::ToJsonString オブジェクトまたは配列を対応するJSON文字列に変換する
Fn::Transform スタックテンプレートの一部に対してカスタム処理を実行するためのマクロを指定する

組み込み関数

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up

CloudFormation テンプレートの書き方と関連ツール

テンプレートとスタック

テンプレートの書き方

Parameters

疑似パラメータ

Resources

リソース属性

Mappings

Outputs

Condition

Rules

Metadata

Outputs

Custom Resources

Dynamic Reference

Modules

デザイナー

ドリフト

StackSets

Macros

Resource Types

Rain

Functions

CloudFormation　テンプレートの書き方と関連ツール