UpdatePolicy 属性

使用 UpdatePolicy 属性来指定 CloudFormation 在堆栈更新操作期间将如何处理特定资源的更新。

概述

通过使用 UpdatePolicy 属性，您可以控制以下资源的更新方式，如下所述：

以下章节描述了每种资源类型所支持的 UpdatePolicy 属性的语法和特性。

WorkSpaces 应用程序更新策略

要在更新之前停止 WorkSpaces 应用程序实例集并在更新后将其重启，请使用 WorkSpaces 应用程序更新策略。

语法

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

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

AutoScalingReplacingUpdate 策略

要替换 Amazon EC2 Auto Scaling 及其包含的实例，请使用 AutoScalingReplacingUpdate 策略。

在尝试更新之前，请确保您具有足够的 Amazon EC2 容量来容纳旧的和新的 Amazon EC2 Auto Scaling 组。

语法

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

UpdatePolicy:
  AutoScalingReplacingUpdate:
    WillReplace: Boolean

属性

AutoScalingRollingUpdate 策略

要对 Amazon EC2 Auto Scaling 组中的实例执行滚动更新，而不是等待扩缩活动逐渐用较新的实例替换旧实例，请使用 AutoScalingRollingUpdate 策略。此策略让您可以灵活指定 CloudFormation 是分批替换 Amazon EC2 Auto Scaling 组中的实例，还是一次性全部替换 Amazon EC2 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 策略。

利用计划操作，Amazon EC2 Auto Scaling 组的组大小属性可随时更改。当您利用 Amazon EC2 Auto Scaling 组和计划操作更新堆栈时，CloudFormation 始终将您的 Amazon EC2 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，您可以更新 NumNodeGroups 资源的 NodeGroupConfiguration 和 AWS::ElastiCache::ReplicationGroup 属性，CloudFormation 将在没有中断的情况下，更新这些属性。如果未指定 UseOnlineResharding 或将其设置为 false，更新 NumNodeGroups 和 NodeGroupConfiguration 属性，将导致 CloudFormation 替换整个 AWS::ElastiCache::ReplicationGroup 资源。

UseOnlineResharding 更新策略没有任何属性。

在将 UseOnlineResharding 更新策略设置为 true 时考虑的事项：

有关修改复制组的更多信息，请参阅 Amazon ElastiCache API Reference 中的 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 Developer Guide》中的 Upgrading OpenSearch Service domains。

语法

"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

属性

有关为 UpdatePolicy 资源指定 AWS::Lambda::Alias 属性的示例，请参阅 Lambda 别名更新策略。

示例

以下示例说明如何将更新策略添加到 Amazon EC2 Auto Scaling 组，以及如何在更新元数据时维护可用性。

将 UpdatePolicy 添加到 Amazon EC2 Auto Scaling 组中

以下示例说明如何添加更新策略。更新期间，Amazon EC2 Auto Scaling 组将更新两批实例并至少保留一个实例可用。由于设置了 WaitOnResourceSignals 标记，Amazon EC2 Auto Scaling 组将等待添加到组中的新实例发送信号。新实例必须在其更新下一批实例之前，向 Amazon EC2 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 策略

以下示例声明在更新期间强制替换关联的 Amazon EC2 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 帮助程序脚本来引导 Amazon EC2 Auto Scaling 组中的实例。CloudFormation 安装软件包、运行命令并执行元数据中描述的其他引导操作。

在仅更新元数据（例如：在将软件包更新为另一个版本时）时，您使用 cfn-hup 帮助程序守护进程检测和应用更新。不过，cfn-hup 守护进程会在每个实例上单独运行。如果守护进程同时在所有实例上运行，则您的应用程序或服务可能在更新期间不可用。要确保可用性，您可以强制滚动更新，以便 CloudFormation 一次更新一批实例。

要强制滚动更新，请更改启动配置资源的逻辑 ID，然后更新堆栈和任何指向原始逻辑 ID 的引用（例如，关联的 Amazon EC2 Auto Scaling 组）。CloudFormation 会触发 Amazon EC2 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