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로 설정하여 사용자가 템플릿에서 MinSize, MaxSize 또는 DesiredCapacity 속성값을 수정하지 않는 한 CloudFormation에서 이러한 값을 변경하지 않도록 합니다.

구문

"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 개발자 안내서의 OpenSearch Service 도메인 업그레이트를 참조하세요.

구문

"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 그룹에 업데이트 정책을 추가하는 방법과 메타데이터 업데이트 시 가용성 유지 관리 방법을 보여줍니다.

auto scaling에 UpdatePolicy 추가

다음 예에서는 업데이트 정책을 추가하는 방법을 보여 줍니다. 업데이트 중 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