CreationPolicy 属性 - AWS CloudFormation

CreationPolicy 属性

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

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

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

AppStream 2.0 作成ポリシー

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

Syntax

JSON

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

YAML

CreationPolicy: StartFleet: Type: Boolean
StartFleet

指定されたフリートを起動します。

必須: いいえ

Amazon EC2 Auto Scaling 作成プロパティ

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

Syntax

JSON

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

YAML

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

Amazon EC2 Auto Scaling 作成プロパティ

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

AutoScalingCreationPolicy

新しい Amazon EC2 Auto Scaling グループには、グループのステータスを CREATE_COMPLETE に設定する前に成功を通知する必要があるインスタンスの数を指定します。

MinSuccessfulInstancesPercent

グループのステータスを CREATE_COMPLETE に設定する前に成功を通知する必要がある Amazon EC2 Auto Scaling のインスタンスの割合を指定します。0100の値を指定できます。CloudFormation は、10% 単位で四捨五入されます。例えば、成功の最小割合が 50 の 5 つのインスタンスを作成する場合、3 つのインスタンスが成功のシグナルを送信する必要があります。Timeout プロパティで指定された時間内にインスタンスから信号が送信されない場合、CloudFormation ではインスタンスが作成されなかったものとみなされます。

デフォルト: 100

タイプ: 整数

必須: いいえ

ResourceSignal

CloudFormation で関連リソースを作成する際に、必要な成功シグナル数と CloudFormation が信号を待機する時間を設定します。

Count

CloudFormation がリソースステータスを CREATE_COMPLETE に設定する前に必要な成功シグナルの受信数です。リソースが失敗シグナルを受信するか、またはタイムアウト期間が時間切れになるまでに指定数のシグナルを受信しなかった場合、リソースの作成は失敗となり CloudFormation はスタックをロールバックします。

デフォルト: 1

タイプ: 整数

必須: いいえ

Timeout

CloudFormation が Count プロパティで指定された数のシグナルを待つ時間です。タイムアウト期間は CloudFormation がリソース作成を開始した後に始まり、タイムアウトは指定した時間より早くはなりませんが、わずかに遅くなる場合があります。指定できる最大時間は 12 時間です。

値は、ISO8601 期間形式PT#H#M#S 形式である必要があります。ここにある # はそれぞれ時間、分数、秒数を表します。最良の結果を得るには、インスタンスが稼働を開始するのに十分な時間を指定します。タイムアウトが短いと、ロールバックが発生する場合があります。

Default: PT5M (5 分)

タイプ: 文字列

必須: いいえ

Auto Scaling グループ

以下の例では、Amazon EC2 Auto Scaling グループへの作成ポリシーの追加方法を説明します。この作成ポリシーは 3 個の成功シグナルを要求し 15 分後にタイムアウトします。

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

JSON
"AutoScalingGroup": { "Type": "AWS::AutoScaling::AutoScalingGroup", "Properties": { "AvailabilityZones": { "Fn::GetAZs": "" }, "LaunchConfigurationName": { "Ref": "LaunchConfig" }, "DesiredCapacity": "3", "MinSize": "1", "MaxSize": "4" }, "CreationPolicy": { "ResourceSignal": { "Count": "3", "Timeout": "PT15M" } }, "UpdatePolicy" : { "AutoScalingScheduledAction" : { "IgnoreUnmodifiedGroupSizeProperties" : "true" }, "AutoScalingRollingUpdate" : { "MinInstancesInService" : "1", "MaxBatchSize" : "2", "PauseTime" : "PT1M", "WaitOnResourceSignals" : "true" } } }, "LaunchConfig": { "Type": "AWS::AutoScaling::LaunchConfiguration", "Properties": { "ImageId": "ami-16d18a7e", "InstanceType": "t2.micro", "UserData": { "Fn::Base64": { "Fn::Join" : [ "", [ "#!/bin/bash -xe\n", "yum install -y aws-cfn-bootstrap\n", "/opt/aws/bin/cfn-signal -e 0 --stack ", { "Ref": "AWS::StackName" }, " --resource AutoScalingGroup ", " --region ", { "Ref" : "AWS::Region" }, "\n" ] ] } } } }
YAML
AutoScalingGroup: Type: AWS::AutoScaling::AutoScalingGroup Properties: AvailabilityZones: Fn::GetAZs: '' LaunchConfigurationName: Ref: LaunchConfig DesiredCapacity: '3' MinSize: '1' MaxSize: '4' CreationPolicy: ResourceSignal: Count: '3' Timeout: PT15M UpdatePolicy: AutoScalingScheduledAction: IgnoreUnmodifiedGroupSizeProperties: 'true' AutoScalingRollingUpdate: MinInstancesInService: '1' MaxBatchSize: '2' PauseTime: PT1M WaitOnResourceSignals: 'true' LaunchConfig: Type: AWS::AutoScaling::LaunchConfiguration Properties: ImageId: ami-16d18a7e InstanceType: t2.micro UserData: "Fn::Base64": !Sub | #!/bin/bash -xe yum update -y aws-cfn-bootstrap /opt/aws/bin/cfn-signal -e $? --stack ${AWS::StackName} --resource AutoScalingGroup --region ${AWS::Region}

WaitCondition

以下の例は、待機条件への作成ポリシーの追加方法について説明します。

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