Attribut UpdatePolicy

Utilisez l’attribut UpdatePolicy pour spécifier la manière dont CloudFormation gère les mises à jour de certaines ressources lors d’opérations de mise à jour de pile.

Présentation

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.

Politique de mise à jour AppStream 2.0

Pour arrêter une flotte AppStream 2.0 avant une mise à jour puis la redémarrer après, utilisez la stratégie de mise à jour AppStream 2.0.

Syntaxe

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

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

Politique AutoScalingReplacingUpdate

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

Politique AutoScalingRollingUpdate

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 stratégie vous permet de spécifier si CloudFormation remplace les instances du groupe Auto Scaling par lots ou en une seule fois, sans remplacer la ressource entière.

É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

Politique AutoScalingScheduledAction

Pour spécifier comment CloudFormation gère les mises à jour des propriétés MinSize, MaxSize et DesiredCapacity lorsque la ressource AWS::AutoScaling::AutoScalingGroup possède une action planifiée, utilisez la stratégie AutoScalingScheduledAction.

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, CloudFormation spécifie toujours les valeurs qui sont définies dans la ressource Auto Scaling de votre modèle pour les valeurs des propriétés de taille de votre groupe AWS::AutoScaling::AutoScalingGroup, même si une action planifiée est en vigueur.

Si vous ne voulez pas que CloudFormation modifie les valeurs des propriétés de taille du groupe lorsqu'une action est planifiée, utilisez la politique de mise à jour AutoScalingScheduledAction et affectez à IgnoreUnmodifiedGroupSizeProperties la valeur true pour empêcher CloudFormation de modifier les propriétés MinSize, MaxSize ou DesiredCapacity, sauf si vous avez modifié ces valeurs dans votre modèle.

Syntaxe

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

UpdatePolicy:
  AutoScalingScheduledAction:
    IgnoreUnmodifiedGroupSizeProperties: Boolean

Propriétés

Politique UseOnlineResharding

Tour 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 est défini sur true, vous pouvez mettre à jour les propriétés NumNodeGroups et NodeGroupConfiguration de la ressource AWS::ElastiCache::ReplicationGroup pour que CloudFormation mette à jour ces propriétés sans interruption. Lorsque UseOnlineResharding est défini sur false, ou n'est pas spécifié, la mise à jour des propriétés NumNodeGroups et NodeGroupConfiguration conduit CloudFormation à remplacer l'ensemble de la ressource AWS::ElastiCache::ReplicationGroup.

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 de plus amples informations sur la modification des groupes de réplication, veuillez consulter ModifyReplicationGroupShardConfiguration.html dans la Amazon ElastiCache API Reference.

Syntaxe

"UpdatePolicy" : {
  "UseOnlineResharding" : Boolean
}

UpdatePolicy:
  UseOnlineResharding: Boolean

Politique EnableVersionUpgrade

Pour mettre à niveau un domaine OpenSearch Service vers une nouvelle version d'OpenSearch ou d'Elasticsearch plutôt que de remplacer l'intégralité de la ressource AWS::OpenSearchService::Domain ou AWS::Elasticsearch::Domain, utilisez la politique de mise à jour EnableVersionUpgrade.

Si EnableVersionUpgrade est défini sur true, vous pouvez mettre à jour la propriété EngineVersion de la ressource AWS::OpenSearchService::Domain (ou la propriété ElasticsearchVersion de la ressource héritée AWS::Elasticsearch::Domain) et CloudFormation la mettra à jour sans interruption. Lorsque EnableVersionUpgrade est défini sur false ou qu'aucune valeur n'est spécifiée, la mise à jour de la propriété EngineVersion ou ElasticsearchVersion entraîne le remplacement de l'ensemble de la ressource AWS::OpenSearchService::Domain/AWS::Elasticsearch::Domain par CloudFormation.

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

Pour plus d’informations, consultez Mise à niveau des domaines OpenSearch Service dans le Guide du développeur Amazon OpenSearch Service.

Syntaxe

"UpdatePolicy" : {
  "EnableVersionUpgrade" : Boolean
}

UpdatePolicy:
  EnableVersionUpgrade: Boolean

Stratégie CodeDeployLambdaAliasUpdate

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

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 un exemple qui spécifie l'attribut UpdatePolicy d'une ressource AWS::Lambda::Alias, consultez la section 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

Politique AutoScalingReplacingUpdate

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 métadonnées AWS::CloudFormation::Init et le script d’assistance cfn-init pour initialiser les instances de votre groupe Auto Scaling. CloudFormation installe les packages, exécute les commandes et effectue les autres opérations 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. Afin de garantir la disponibilité, vous pouvez imposer une mise à jour propagée de sorte que CloudFormation mette à jour les instances lot après lot.

Pour imposer une mise à jour propagée, modifiez l'ID logique de la ressource de configuration de lancement, puis mettez à jour la pile et les références qui renvoient vers l'ID logique d'origine (telles que le groupe Auto Scaling associé). CloudFormation déclenche une mise à jour propagée sur le groupe Auto Scaling, 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