Attribut UpdatePolicy

Utilisez l'UpdatePolicyattribut pour spécifier le mode de gestion des mises CloudFormation à jour de certaines ressources lors des opérations de mise à jour de la pile.

Présentation de

En utilisant l’attribut UpdatePolicy, vous pouvez contrôler la mise à jour des ressources suivantes, comme décrit ci-dessous :

Les sections suivantes décrivent la syntaxe et les propriétés de l’attribut UpdatePolicy pris en charge pour chaque type de ressource.

WorkSpaces Politique de mise à jour des applications

Pour arrêter un parc d' WorkSpaces applications avant une mise à jour et le redémarrer après une mise à jour, utilisez la politique de mise à jour WorkSpaces des applications.

Syntaxe

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

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

AutoScalingReplacingUpdate politique

Pour remplacer le groupe Auto Scaling ainsi que toutes les instances qu’il contient, utilisez la stratégie AutoScalingReplacingUpdate.

Avant de tenter une mise à jour, assurez-vous de disposer d'une capacité Amazon EC2 suffisante, à la fois pour les groupes Auto Scaling anciens et nouveaux.

Syntaxe

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

UpdatePolicy:
  AutoScalingReplacingUpdate:
    WillReplace: Boolean

Propriétés

AutoScalingRollingUpdate politique

Pour effectuer une mise à jour progressive des instances d’un groupe Auto Scaling, plutôt que d’attendre que les actions de mise à l’échelle remplacent progressivement les anciennes instances par des instances plus neuves, utilisez la stratégie AutoScalingRollingUpdate. Cette politique vous donne la flexibilité de spécifier si elle CloudFormation remplace les instances d'un groupe Auto Scaling par lots ou en une seule fois sans remplacer la ressource dans son intégralité.

Éléments à prendre en compte lors de l’utilisation d’une stratégie AutoScalingRollingUpdate :

Syntaxe

"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

Propriétés

AutoScalingScheduledAction politique

Pour spécifier le mode CloudFormation de gestion des mises à jour DesiredCapacity des propriétés MinSizeMaxSize, et lorsque la AWS::AutoScaling::AutoScalingGroup ressource est associée à une action planifiée, utilisez la AutoScalingScheduledAction politique.

Avec des actions planifiées, les propriétés de taille d'un groupe Auto Scaling peuvent changer à tout moment. Lorsque vous mettez à jour une pile avec un groupe Auto Scaling et une action planifiée, définissez CloudFormation toujours les valeurs des propriétés de taille de groupe de votre groupe Auto Scaling sur les valeurs définies dans la AWS::AutoScaling::AutoScalingGroup ressource de votre modèle, même si une action planifiée est en cours d'exécution.

Si vous ne CloudFormation souhaitez modifier aucune des valeurs des propriétés de taille de groupe lorsqu'une action planifiée est en vigueur, utilisez la politique de AutoScalingScheduledAction mise à jour et IgnoreUnmodifiedGroupSizeProperties configurez-la true pour CloudFormation empêcher de modifier les DesiredCapacity propriétés MinSizeMaxSize, ou à moins que vous n'ayez modifié ces valeurs dans votre modèle.

Syntaxe

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

UpdatePolicy:
  AutoScalingScheduledAction:
    IgnoreUnmodifiedGroupSizeProperties: Boolean

Propriétés

UseOnlineResharding politique

Pour modifier les partitions d'un groupe de réplication en ajoutant ou en supprimant des partitions plutôt qu'en remplaçant la ressource AWS::ElastiCache::ReplicationGroup dans son intégralité, utilisez la politique de mise à jour UseOnlineResharding.

Si UseOnlineResharding ce paramètre est défini surtrue, vous pouvez mettre à jour les NodeGroupConfiguration propriétés NumNodeGroups et de la AWS::ElastiCache::ReplicationGroup ressource, et vous CloudFormation mettrez à jour ces propriétés sans interruption. Lorsqu'elle UseOnlineResharding est définie sur ou non spécifiéefalse, la mise à jour des NodeGroupConfiguration propriétés NumNodeGroups et entraîne le CloudFormation remplacement de la AWS::ElastiCache::ReplicationGroup ressource dans son intégralité.

La politique de mise à jour UseOnlineResharding n'a pas de propriétés.

Éléments à prendre en compte lors de la définition de la politique de mise à jour UseOnlineResharding sur true :

Pour plus d'informations sur la modification des groupes de réplication, consultez ModifyReplicationGroupShardConfigurationle Amazon ElastiCache API Reference.

Syntaxe

"UpdatePolicy" : {
  "UseOnlineResharding" : Boolean
}

UpdatePolicy:
  UseOnlineResharding: Boolean

EnableVersionUpgrade politique

Pour mettre à niveau un domaine de OpenSearch service vers une nouvelle version d' OpenSearch Elasticsearch plutôt que de remplacer la totalité de la AWS::Elasticsearch::Domainressource AWS::OpenSearchService::DomainOR, utilisez la politique de EnableVersionUpgrade mise à jour.

Si EnableVersionUpgrade ce paramètre est défini surtrue, vous pouvez mettre à jour la EngineVersion propriété de la AWS::OpenSearchService::Domain ressource (ou la ElasticsearchVersion propriété de l'ancienne AWS::Elasticsearch::Domain ressource), et CloudFormation vous mettrez à jour cette propriété sans interruption. Lorsqu'elle EnableVersionUpgrade est définie sur ou non spécifiéefalse, la mise à jour de la ElasticsearchVersion propriété EngineVersion or entraîne le CloudFormation remplacement de l'intégralité de la AWS::Elasticsearch::Domain ressourceAWS::OpenSearchService::Domain/.

La politique de mise à jour EnableVersionUpgrade n'a pas de propriétés.

Pour plus d'informations, consultez la section Mise à niveau des domaines de OpenSearch service dans le manuel Amazon OpenSearch Service Developer Guide.

Syntaxe

"UpdatePolicy" : {
  "EnableVersionUpgrade" : Boolean
}

UpdatePolicy:
  EnableVersionUpgrade: Boolean

CodeDeployLambdaAliasUpdate politique

Pour effectuer un CodeDeploy déploiement lorsque la version d'une AWS::Lambda::Alias ressource change, utilisez la politique de CodeDeployLambdaAliasUpdate mise à jour.

Syntaxe

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

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

Propriétés

Pour obtenir un exemple de spécification de l'attribut UpdatePolicy pour une ressource AWS::Lambda::Alias, consultez Politique de mise à jour d'alias lambda.

Exemples

Les exemples suivants montrent comment ajouter une politique de mise à jour à un groupe Auto Scaling et comment assurer la disponibilité lors de la mise à jour des métadonnées.

Ajout d'une UpdatePolicy à un groupe Auto Scaling

L'exemple suivant montre comment ajouter une politique de mise à jour. Pendant une mise à jour, le groupe Auto Scaling met à jour les instances par lots de deux et maintient au moins une instance en service. Étant donné que l'indicateur WaitOnResourceSignals est défini, le groupe Auto Scaling attend les nouvelles instances qui sont ajoutées au groupe. Les nouvelles instances doivent envoyer un signal au groupe Auto Scaling, avant qu'il ne mette à jour le lot d'instances suivant.

"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 politique

L'exemple suivant déclare une politique qui force le remplacement d'un groupe Auto Scaling associé au cours d'une mise à jour. Pour que la mise à jour réussisse, un pourcentage d'instances (spécifié par le paramètre MinSuccessfulPercentParameter) doit indiquer la réussite avant l'expiration du délai (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'

Disponibilité lors de la mise à jour des métadonnées pour le script d'assistant cfn-init

Lorsque vous installez des applications logicielles sur vos instances, vous pouvez utiliser la clé de AWS::CloudFormation::Init métadonnées et le script d'cfn-initassistance pour démarrer les instances de votre groupe Auto Scaling. CloudFormation installe les packages, exécute les commandes et exécute les autres actions d'amorçage décrites dans les métadonnées.

Lorsque vous mettez à jour uniquement les métadonnées (par exemple, lors du passage d'un package à une autre version), vous pouvez utiliser le programme démon cfn-hup pour détecter et appliquer les mises à jour. Toutefois, le programme démon cfn-hup est exécuté indépendamment dans chaque instance. S'il est exécuté en même temps dans toutes les instances, votre service ou votre application peut être indisponible pendant la mise à jour. Pour garantir la disponibilité, vous pouvez forcer une mise à jour continue afin de mettre CloudFormation à jour vos instances un lot à la fois.

Pour forcer une mise à jour continue, modifiez l'ID logique de la ressource de configuration de lancement, puis mettez à jour la pile et toutes les références pointant vers l'ID logique d'origine (tel que le groupe Auto Scaling associé). CloudFormation déclenche une mise à jour continue sur le groupe Auto Scaling, en remplaçant toutes les instances.

Modèle d'origine

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

Mise à jour de l'ID logique

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

Politique de mise à jour d'alias lambda

L'exemple suivant précise l'attribut UpdatePolicy pour une ressource AWS::Lambda::Alias. Tous les détails du déploiement sont définis par l'application et le groupe de déploiement qui sont transmis dans la politique.

"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