テンプレートでの待機条件の作成

スタックで待機条件を使用するには:

1. スタックのテンプレートで AWS::CloudFormation::WaitConditionHandle リソースを宣言します。待機条件ハンドルには、プロパティがありません。ただし、WaitConditionHandle リソースへの参照は、WaitCondition に成功または失敗のシグナルを送信するために使用できる署名済み URL に解決されます。例:

   "myWaitHandle" : {
        "Type" : "AWS::CloudFormation::WaitConditionHandle",
        "Properties" : {
        }
   }

2. スタックのテンプレートで AWS::CloudFormation::WaitCondition リソースを宣言します。WaitCondition リソースには、2 つの必須プロパティがあります。Handle はテンプレートで宣言されている WaitConditionHandle への参照で、Timeout は AWS CloudFormation が待機する数秒です。オプションで、Count プロパティを設定できます。このプロパティは、AWS CloudFormation がスタックの作成を再開するために待機条件が受信しなければならない成功シグナルの数を決定します。

   待機条件がいつトリガーされるかを制御するには、待機条件の DependsOn 属性を設定します。DependsOn 句は、リソースを待機条件に関連付けます。AWS CloudFormation は、DependsOn リソースの作成後、次のいずれかのイベントが発生するまでスタックリソースの作成をブロックします。a) タイムアウト期間が経過した b) 必要な数の成功シグナルを受信した c) 失敗シグナルを受信した。

   以下の待機条件の例は、Ec2Instance リソースの作成が成功した後に開始され、myWaitHandle リソースを WaitConditionHandle として使用します。タイムアウトは 4500 秒で、デフォルト Count は 1 です (Count プロパティが指定されていないため)。

   "myWaitCondition" : {
       "Type" : "AWS::CloudFormation::WaitCondition",
       "DependsOn" : "Ec2Instance",
       "Properties" : {
           "Handle" : { "Ref" : "myWaitHandle" },
           "Timeout" : "4500"
       }
   }

3. シグナル送信に使用する署名済み URL を取得します。

   テンプレートで署名済み URL を取得するには、Ref 組み込み関数に AWS::CloudFormation::WaitConditionHandle リソースの論理名を渡します。例えば、AWS::EC2::Instance リソースの UserData プロパティを使用して、署名済み URL を Amazon EC2 インスタンスに渡すと、そのインスタンスで実行されているスクリプトまたはアプリケーションが成功または失敗のシグナルを AWS CloudFormation に送信できます。

   "UserData" : {
      "Fn::Base64" : {
          "Fn::Join" : [ "", ["SignalURL=", { "Ref" : "myWaitHandle" } ] ]
      }
   }

   注意: AWS Management Console または AWS CloudFormation コマンドラインツールでは、署名済み URL は待機条件ハンドルリソースの物理 ID として表示されます。

4. スタックがいつ待機条件に入るかを検出する方法を選択します。

   通知を有効にしてスタックを作成した場合、AWS CloudFormation はすべてのスタックイベントの通知を指定のトピックに発行します。ユーザーまたはアプリケーションがそのトピックにサブスクライブしている場合は、待機条件ハンドル作成イベントの通知を監視し、通知メッセージから署名済み URL を取得できます。

   AWS Management Console、AWS CloudFormation コマンドラインツール、または AWS CloudFormation API を使用して、スタックのイベントをモニタリングすることもできます。

5. 署名済み URL を使用して、成功または失敗のシグナルを送信します。

   シグナルを送信するには、署名済み URL を使用して HTTP リクエストメッセージを送信します。リクエスト方法は PUT である必要があります。Content-Type ヘッダーは空の文字列であるか省略される必要があります。リクエストメッセージは、「待機条件シグナルの JSON 形式」で指定されている形式の JSON 構造である必要があります。

   AWS CloudFormation によってスタックの作成が続行されるようにするには、Count プロパティで指定された数の成功シグナルを送信する必要があります。Count が 1 より大きい場合、各シグナルの UniqueId 値は、特定の待機条件に送信されるすべてのシグナルにわたって一意である必要があります。UniqueId は任意の英数字の文字列です。

   curl コマンドは、シグナルを送信する方法の 1 つです。次の例は、待機条件に成功のシグナルを送信する curl コマンドラインを示しています。

   $ curl -T /tmp/a \
     "https://cloudformation-waitcondition-test.s3.amazonaws.com/arn%3Aaws%3Acloudformation%3Aus-east-2%3A034017226601%3Astack%2Fstack-gosar-20110427004224-test-stack-with-WaitCondition--VEYW%2Fe498ce60-70a1-11e0-81a7-5081d0136786%2FmyWaitConditionHandle?Expires=1303976584&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Signature=ik1twT6hpS4cgNAw7wyOoRejVoo%3D"

   ファイル /tmp/a には、次の JSON 構造が格納されます。

   
   {
      "Status" : "SUCCESS",
      "Reason" : "Configuration Complete",
      "UniqueId" : "ID1234",
      "Data" : "Application has completed configuration."
   }

   この例は、同じ成功のシグナルを送信する curl コマンドラインを示していますが、コマンドラインのパラメータとして JSON 構造を送信している点が異なります。

   $ curl -X PUT \
     -H 'Content-Type:' --data-binary '{"Status" : "SUCCESS","Reason" : "Configuration Complete","UniqueId" : "ID1234","Data" : "Application has completed configuration."}' \
     "https://cloudformation-waitcondition-test.s3.amazonaws.com/arn%3Aaws%3Acloudformation%3Aus-east-2%3A034017226601%3Astack%2Fstack-gosar-20110427004224-test-stack-with-WaitCondition--VEYW%2Fe498ce60-70a1-11e0-81a7-5081d0136786%2FmyWaitConditionHandle?Expires=1303976584&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Signature=ik1twT6hpS4cgNAw7wyOoRejVoo%3D"