CreationPolicy 属性

CreationPolicy 属性をリソースに関連付けて、AWS CloudFormation が指定数の成功シグナルを受信するかまたはタイムアウト期間が超過するまでは、ステータスが作成完了にならないようにします。リソースにシグナルを送るには、cfn-signal ヘルパースクリプトまたは SignalResource API を使用します。CloudFormation は、送信されたシグナル数を追跡できるように、有効なシグナルをスタックイベントにパブリッシュします。

作成ポリシーは、CloudFormation が関連するリソースを作成するときのみ実行されます。現在、作成ポリシーをサポートしているリソースは CloudFormation のみです。

スタックの作成に進む前にリソース構成アクションを待機する場合は、CreationPolicy 属性を使用します。たとえば、EC2 インスタンスにソフトウェアアプリケーションをインストールして設定する際に、先に進む前にこのアプリケーションを起動して実行する場合があります。このような場合、インスタンスに CreationPolicy 属性を追加すると、アプリケーションがインストールされ設定された後に、インスタンスに成功シグナルを送信します。詳細な例については、『AWS CloudFormation ユーザーガイド』の「CloudFormation による Amazon EC2 へのアプリケーションのデプロイ」を参照してください。

AppStream 2.0 作成ポリシー

作成ポリシーに対する Amazon AppStream 構成。

構文

{
    "CreationPolicy": {
        "StartFleet": {
            "Type": "Boolean"
        }
    }
}

CreationPolicy:
  StartFleet:
    Type: Boolean

Amazon EC2 Auto Scaling 作成プロパティ

作成ポリシーに対する Amazon EC2 Auto Scaling 設定。

構文

"CreationPolicy" : {
  "AutoScalingCreationPolicy" : {
    "MinSuccessfulInstancesPercent" : Integer
  },
  "ResourceSignal" : {    
    "Count" : Integer,
    "Timeout" : String
  }
}

CreationPolicy:
  AutoScalingCreationPolicy:
    MinSuccessfulInstancesPercent: Integer
  ResourceSignal:    
    Count: Integer
    Timeout: String

Amazon EC2 Auto Scaling 作成プロパティ

作成ポリシーに対する Amazon EC2 Auto Scaling 設定。

例

Auto Scaling グループ

以下の例では、Amazon EC2 Auto Scaling グループへの作成ポリシーの追加方法を説明します。この作成ポリシーは 3 個の成功シグナルを要求し 15 分後にタイムアウトします。cfn-signal ヘルパースクリプトを使用して、インスタンス作成プロセスが正常に完了したときにシグナルを送信します。

インスタンスが Elastic Load Balancing ヘルスチェックに成功してから成功シグナルを送信する場合は、cfn-init ヘルパースクリプトを使用してヘルスチェック検証を追加します。例については、GitHub リポジトリにある Amazon EC2 Auto Scaling ローリングアップデートのサンプルテンプレートの verify_instance_health コマンドを参照してください。

"AutoScalingGroup": {
  "Type": "AWS::AutoScaling::AutoScalingGroup",
  "Properties": {
    "VPCZoneIdentifier":[ "subnetIdAz1", "subnetIdAz2", "subnetIdAz3" ],
    "LaunchTemplate":{
      "LaunchTemplateId":{
        "Ref":"logicalName"
      },
      "Version":{
        "Fn::GetAtt":[
          "logicalName",
          "LatestVersionNumber"
        ]
      }
    },
    "MinSize": "1",
    "MaxSize": "4"
  },
  "CreationPolicy": {
    "ResourceSignal": {
      "Count": "3",
      "Timeout": "PT15M"
    }
  }
}

AutoScalingGroup:
  Type: AWS::AutoScaling::AutoScalingGroup
  Properties:
    VPCZoneIdentifier:
      - subnetIdAz1
      - subnetIdAz2
      - subnetIdAz3
    LaunchTemplate:
      LaunchTemplateId: !Ref logicalName
      Version: !GetAtt logicalName.LatestVersionNumber
    MinSize: '1'
    MaxSize: '4'
  CreationPolicy:
    ResourceSignal:
      Count: '3'
      Timeout: PT15M

WaitCondition

次の例は、Amazon EC2 を超えて CloudFormation リソースの待機条件に作成ポリシーを追加する方法を示しています。

WaitCondition リソースにシグナルを送信するには、SignalResource API を使用します。この API は、CreationPolicy を使用して設定した WaitCondition リソースで機能するように設計されています。

"WaitCondition" : {
    "Type" : "AWS::CloudFormation::WaitCondition",
    "CreationPolicy" : {
        "ResourceSignal" : {
            "Timeout" : "PT15M",
            "Count" : "5"
        }
    }
}

WaitCondition:
  Type: AWS::CloudFormation::WaitCondition
  CreationPolicy:
    ResourceSignal:
      Timeout: PT15M
      Count: 5