UpdatePolicy 属性

UpdatePolicy 属性を使用して、スタック更新操作中に AWS CloudFormation が特定のリソースに対する更新を処理する方法を指定します。

概要

次の説明にあるように、UpdatePolicy 属性を使用することで、以下のリソースの更新方法を制御することができます。

この後のセクションでは、各リソースタイプでサポートされる UpdatePolicy 属性の構文とプロパティを説明します。

AppStream 2.0 の更新ポリシー

更新前に AppStream 2.0 フリートを停止し、更新後に再起動するには、AppStream 2.0 更新ポリシーを使用します。

構文

{
    "UpdatePolicy": {
        "StopBeforeUpdate": {
            "Type": "Boolean"
        },
        "StartAfterUpdate": {
            "Type": "Boolean"
        }
    }
}

UpdatePolicy:
  StopBeforeUpdate:
    Type: Boolean
  StartAfterUpdate:
    Type: Boolean

AutoScalingReplacingUpdate ポリシー

Auto Scaling グループと、それに含まれるインスタンスを置き換えるには、AutoScalingReplacingUpdate ポリシーを使用します。

更新を実行する前に、新旧両方の Auto Scaling グループに Amazon EC2 キャパシティーが十分あることを確認してください。

構文

"UpdatePolicy" : {
  "AutoScalingReplacingUpdate" : {
    "WillReplace" : Boolean
  }
}

UpdatePolicy:
  AutoScalingReplacingUpdate:
    WillReplace: Boolean

プロパティ

AutoScalingRollingUpdate ポリシー

スケーリングアクティビティが古いインスタンスを新しいインスタンスに徐々に置き換えるのを待つ代わりに、Auto Scaling グループ内のインスタンスのローリング更新を実行するには、AutoScalingRollingUpdate ポリシーを使用します。このポリシーは、CloudFormation が Auto Scaling グループ内のインスタンスをバッチ単位で置き換えるか、リソース全体を置き換えずにすべてのインスタンスを一度に置き換えるかを指定する柔軟性を提供します。

AutoScalingRollingUpdate ポリシーを使用する際に考慮すべきこと:

構文

"UpdatePolicy" : {
  "AutoScalingRollingUpdate" : {
    "MaxBatchSize" : Integer,
    "MinActiveInstancesPercent" : Integer,
    "MinInstancesInService" : Integer,
    "MinSuccessfulInstancesPercent" : Integer,
    "PauseTime" : String,
    "SuspendProcesses" : [ List of processes ],
    "WaitOnResourceSignals" : Boolean
  }
}

UpdatePolicy:
  AutoScalingRollingUpdate:
    MaxBatchSize: Integer
    MinActiveInstancesPercent: Integer
    MinInstancesInService: Integer
    MinSuccessfulInstancesPercent: Integer
    PauseTime: String
    SuspendProcesses:
      - List of processes
    WaitOnResourceSignals: Boolean

プロパティ

AutoScalingScheduledAction ポリシー

スケジュールされたアクションが AWS::AutoScaling::AutoScalingGroup リソースに関連付けられているときに CloudFormation が MinSize、MaxSize、DesiredCapacity の各プロパティの更新を処理する方法を指定するには、AutoScalingScheduledAction ポリシーを使用します。

スケジュールされたアクションを使用すると、Auto Scaling グループのグループサイズプロパティはいつでも変化する可能性があります。Auto Scaling グループやスケジュールされたアクションを含むスタックが更新されると、スケジュールされたアクションが有効になっている場合でも、CloudFormation は Auto Scaling グループのグループサイズのプロパティ値を、テンプレート内の AWS::AutoScaling::AutoScalingGroup リソースで定義されている値に設定します。

スケジュールされたアクションが有効なときに CloudFormation がどのグループサイズプロパティ値も変更しないようにするには、AutoScalingScheduledAction 更新ポリシーを使用して IgnoreUnmodifiedGroupSizeProperties を true に設定し、テンプレートで値を変更しない限り、CloudFormation が MinSize、MaxSize、または DesiredCapacity プロパティを変更しないようにします。

構文

"UpdatePolicy" : {
  "AutoScalingScheduledAction" : {
    "IgnoreUnmodifiedGroupSizeProperties" : Boolean
  }
}

UpdatePolicy:
  AutoScalingScheduledAction:
    IgnoreUnmodifiedGroupSizeProperties: Boolean

プロパティ

UseOnlineResharding ポリシー

AWS::ElastiCache::ReplicationGroup リソース全体を置き換えるのではなく、シャードを追加または削除してレプリケーションを変更するには、UseOnlineResharding 更新ポリシーを使用します。

UseOnlineResharding が true に設定されている場合、AWS::ElastiCache::ReplicationGroup リソースの NumNodeGroups プロパティと NodeGroupConfiguration プロパティを更新でき、CloudFormation は中断することなく、これらのプロパティを更新します。UseOnlineResharding が false に設定されている場合、または指定しない場合、NumNodeGroups プロパティおよび NodeGroupConfiguration プロパティを更新すると、CloudFormation が AWS::ElastiCache::ReplicationGroup リソース全体を置き換えます。

UseOnlineResharding 更新ポリシーにはプロパティがありません。

UseOnlineResharding 更新ポリシーを true に設定するときは、次の点を考慮します。

レプリケーショングループを変更する方法の詳細については、「Amazon ElastiCache API リファレンス」の「ModifyReplicationGroupShardConfiguration」を参照してください。

構文

"UpdatePolicy" : {
  "UseOnlineResharding" : Boolean
}

UpdatePolicy:
  UseOnlineResharding: Boolean

EnableVersionUpgrade ポリシー

すべての AWS::OpenSearchService::Domain または AWS::Elasticsearch::Domain リソースを置き換えるのではなく、OpenSearch Service ドメインを OpenSearch または Elasticsearch の新しいバージョンにアップグレードする場合は、EnableVersionUpgrade 更新ポリシーを使用します。

EnableVersionUpgrade が true に設定されている場合、AWS::OpenSearchService::Domain リソースの EngineVersion プロパティ (またはレガシー AWS::Elasticsearch::Domain リソースの ElasticsearchVersion プロパティ) を更新することができます。これにより、CloudFormation が中断することなくそのプロパティを更新します。EnableVersionUpgrade が false に設定されているか、指定されていない場合、EngineVersion または ElasticsearchVersion プロパティを更新すると、CloudFormation は AWS::OpenSearchService::Domain/AWS::Elasticsearch::Domain リソース全体を置き換えます。

EnableVersionUpgrade 更新ポリシーにはプロパティがありません。

詳細については、「Amazon OpenSearch Service デベロッパーガイド」の「Amazon OpenSearch Service ドメインのアップグレード」を参照してください。

構文

"UpdatePolicy" : {
  "EnableVersionUpgrade" : Boolean
}

UpdatePolicy:
  EnableVersionUpgrade: Boolean

CodeDeployLambdaAliasUpdate ポリシー

CodeDeployLambdaAliasUpdate リソースでのバージョンの変更時に CodeDeploy デプロイを実行するには、AWS::Lambda::Alias 更新ポリシーを使用します。

構文

"UpdatePolicy" : {
  "CodeDeployLambdaAliasUpdate" : {
    "AfterAllowTrafficHook" : String,
    "ApplicationName" : String,
    "BeforeAllowTrafficHook" : String,
    "DeploymentGroupName" : String
  }
}

UpdatePolicy:
  CodeDeployLambdaAliasUpdate:
    AfterAllowTrafficHook: String
    ApplicationName: String
    BeforeAllowTrafficHook: String
    DeploymentGroupName: String

プロパティ

AWS::Lambda::Alias リソースの UpdatePolicy 属性を指定する例については、「Lambda エイリアスの更新ポリシー」を参照してください。

例

次の例では、更新グループを Auto Scaling グループに追加する方法と、メタデータの更新時に可用性を維持する方法を示します。

Auto Scaling グループに UpdatePolicy を追加します。

次の例は、更新ポリシーの追加方法を示しています。更新中、Auto Scaling グループは 2 個のインスタンスのバッチを更新し、少なくとも 1 つのインスタンスをサービスで最低 1 個のインスタンスを稼動状態にします。WaitOnResourceSignals フラグが設定されているため、Auto Scaling グループはグループに追加される新しいインスタンスを待機します。新しいインスタンスは、次のインスタンスのバッチを更新する前に、Auto Scaling グループにシグナルを送信する必要があります。

"ASG" : {
  "Type":"AWS::AutoScaling::AutoScalingGroup",
  "Properties":{
    "VPCZoneIdentifier":[ "subnetIdAz1", "subnetIdAz2", "subnetIdAz3" ],
    "LaunchTemplate":{
      "LaunchTemplateId":{
        "Ref":"logicalName"
      },
      "Version":{
        "Fn::GetAtt":[
          "logicalName",
          "LatestVersionNumber"
        ]
      }
    },
    "MaxSize":"4",
    "MinSize":"1"
  },
  "UpdatePolicy":{
    "AutoScalingScheduledAction":{
      "IgnoreUnmodifiedGroupSizeProperties":"true"
    },
    "AutoScalingRollingUpdate":{
      "MinInstancesInService":"1",
      "MaxBatchSize":"2",
      "WaitOnResourceSignals":"true",
      "PauseTime":"PT10M",
      "SuspendProcesses":[
        "HealthCheck",
        "ReplaceUnhealthy",
        "AZRebalance",
        "AlarmNotification",
        "ScheduledActions",
        "InstanceRefresh"
      ]
    }
  }
}

ASG:
  Type: 'AWS::AutoScaling::AutoScalingGroup'
  Properties:
    VPCZoneIdentifier:
      - subnetIdAz1
      - subnetIdAz2
      - subnetIdAz3
    LaunchTemplate:
      LaunchTemplateId: !Ref logicalName
      Version: !GetAtt logicalName.LatestVersionNumber
    MaxSize: '4'
    MinSize: '1'
  UpdatePolicy:
    AutoScalingScheduledAction:
      IgnoreUnmodifiedGroupSizeProperties: 'true'
    AutoScalingRollingUpdate:
      MinInstancesInService: '1'
      MaxBatchSize: '2'
      WaitOnResourceSignals: 'true'
      PauseTime: PT10M
      SuspendProcesses:
        - HealthCheck
        - ReplaceUnhealthy
        - AZRebalance
        - AlarmNotification
        - ScheduledActions
        - InstanceRefresh

AutoScalingReplacingUpdate ポリシー

次の例では、関連付けられた Auto Scaling グループを更新時に強制的に置き換えるポリシーを宣言しています。更新が成功するためには、インスタンスの割合 (MinSuccessfulPercentParameter パラメーターにより指定) が Timeout 期間内に成功のシグナルを送信する必要があります。

"UpdatePolicy" : {
  "AutoScalingReplacingUpdate" : {
    "WillReplace" : true
  }
},
"CreationPolicy" : {
  "ResourceSignal" : {
    "Count" : { "Ref" : "ResourceSignalsOnCreate"},
    "Timeout" : "PT10M"
  },
  "AutoScalingCreationPolicy" : {
    "MinSuccessfulInstancesPercent" : { "Ref" : "MinSuccessfulPercentParameter" }
  }
}

UpdatePolicy:
  AutoScalingReplacingUpdate:
    WillReplace: true
CreationPolicy:
  ResourceSignal:
    Count: !Ref 'ResourceSignalsOnCreate'
    Timeout: PT10M
  AutoScalingCreationPolicy:
    MinSuccessfulInstancesPercent: !Ref 'MinSuccessfulPercentParameter'

cfn-init Helper スクリプトのメタデータを更新する際の可用性の維持

インスタンスにソフトウェアアプリケーションをインストールするとき、AWS::CloudFormation::Init メタデータキーと cfn-init ヘルパースクリプトを使用して、Auto Scaling グループ内のインスタンスをブートストラップすることができます。CloudFormation がパッケージをインストールしてコマンドを実行し、メタデータに記述されている他のブートストラップアクションを実行します。

メタデータのみ更新する場合 (たとえば、パッケージを別のバージョンに更新する場合)、cfn-hup ヘルパーデーモンを使用して更新を検出し、適用できます。ただし、cfn-hup デーモンはインスタンスごとに別個に実行されます。デーモンがすべてのインスタンスで同時に実行されてしまった場合、アプリケーションまたはサービスが更新中に使用不可能になる可能性があります。可用性を確保するには、CloudFormation が一度に 1 つのバッチでインスタンスを更新するようにローリング更新を強制します。

ローリング更新を強制するには、起動構成リソースの論理 ID を変更した後、スタックと、元の論理 ID (関連付けられている Auto Scaling グループなど) を指すすべての参照を更新します。CloudFormation が Auto Scaling グループ上でローリング更新をトリガーし、すべてのインスタンスを置き換えます。

元のテンプレート

"LaunchConfig": {
  "Type" : "AWS::AutoScaling::LaunchConfiguration",
  "Metadata" : {
    "Comment" : "Install a simple PHP application",
    "AWS::CloudFormation::Init" : {
    ...
    }
  }
}

更新された論理 ID

"LaunchConfigUpdateRubygemsPkg": {
  "Type" : "AWS::AutoScaling::LaunchConfiguration",
  "Metadata" : {
    "Comment" : "Install a simple PHP application",
    "AWS::CloudFormation::Init" : {
    ...
    }
  }
}

Lambda エイリアスの更新ポリシー

次の例では、UpdatePolicy リソースの AWS::Lambda::Alias 属性を指定します。デプロイの詳細はすべて、ポリシーに渡されるアプリケーションおよびデプロイグループによって定義されます。

"Alias": {
  "Type": "AWS::Lambda::Alias",
  "Properties": {
    "FunctionName": {
      "Ref": "LambdaFunction"
    },
    "FunctionVersion": {
      "Fn::GetAtt": [
        "FunctionVersionTwo",
        "Version"
      ]
    },
    "Name": "MyAlias"
  },
  "UpdatePolicy": {
    "CodeDeployLambdaAliasUpdate": {
      "ApplicationName": {
        "Ref": "CodeDeployApplication"
      },
      "DeploymentGroupName": {
        "Ref": "CodeDeployDeploymentGroup"
      },
      "BeforeAllowTrafficHook": {
        "Ref": "PreHookLambdaFunction"
      },
      "AfterAllowTrafficHook": {
        "Ref": "PreHookLambdaFunction"
      }
    }
  }
}

Alias:
  Type: 'AWS::Lambda::Alias'
  Properties:
    FunctionName: !Ref LambdaFunction
    FunctionVersion: !GetAtt FunctionVersionTwo.Version
    Name: MyAlias
  UpdatePolicy:
    CodeDeployLambdaAliasUpdate:
      ApplicationName: !Ref CodeDeployApplication
      DeploymentGroupName: !Ref CodeDeployDeploymentGroup
      BeforeAllowTrafficHook: !Ref PreHookLambdaFunction
      AfterAllowTrafficHook: !Ref PreHookLambdaFunction