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政策。

在嘗試更新之前，請確定您有足夠的 Amazon EC2 容量，以同時容納舊的與新的 Auto Scaling 群組。

語法

"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資源具有相關聯的排程動作時MaxSize，CloudFormation 如何處理 MinSize、 和 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 Reference (《Amazon ElastiCache API 參考》) 中的 ModifyReplicationGroupShardConfiguration。

語法

"UpdatePolicy" : {
  "UseOnlineResharding" : Boolean
}

UpdatePolicy:
  UseOnlineResharding: Boolean

EnableVersionUpgrade 政策

若要將 OpenSearch Service 網域升級為 OpenSearch 或 Elasticsearch 的新版本，而非取代整個 AWS::OpenSearchService::Domain 或 AWS::Elasticsearch::Domain 資源，請使用 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 開發人員指南》中的升級 OpenSearch Service 網域。 OpenSearch

語法

"UpdatePolicy" : {
  "EnableVersionUpgrade" : Boolean
}

UpdatePolicy:
  EnableVersionUpgrade: Boolean

CodeDeployLambdaAliasUpdate 政策

若要在 AWS::Lambda::Alias 資源進行版本變更時執行 CodeDeploy 部署，請使用 CodeDeployLambdaAliasUpdate 更新政策。

語法

"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 群組，以及如何在更新中繼資料時保持可用性。

將 UpdatePolicy 新增至 Auto Scaling 群組

以下範例說明如何新增更新政策。在更新期間，Auto Scaling 群組將以兩個為一批更新執行個體，並至少保持一個服務中的執行個體。由於已設定 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 協助程式指令碼的中繼資料時維持可用性

當您在執行個體上安裝軟體應用程式時，可使用 AWS::CloudFormation::Init 中繼資料金鑰與 cfn-init 協助程式指令碼以引導 Auto Scaling 群組中的執行個體。CloudFormation 安裝套件、執行命令，並執行中繼資料中所描述的其他引導動作。

當您僅更新中繼資料時 (例如，將套件更新為另一個版本時)，可使用 cfn-hup 協助程式以偵測和套用更新。但是，cfn-hup 協助程式獨立執行於每個執行個體。如果協助程式剛好在所有執行個體上同時執行，您的應用程式或服務在更新期間可能會無法使用。為了保證可用性，您可以強制滾動更新，使 CloudFormation 每次更新一個批次的執行個體。

若要強制執行滾動更新，請變更啟動組態資源的邏輯 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