Atributo UpdatePolicy

Utilice el atributo UpdatePolicy para especificar la manera en que AWS CloudFormation administra las actualizaciones de ciertos recursos durante las operaciones de actualización de pilas.

Información general

Con el atributo UpdatePolicy, puede controlar la manera en que los siguientes recursos se actualizan, tal como se describe a continuación:

En las secciones que figuran a continuación se describen la sintaxis y las propiedades del atributo UpdatePolicy compatible con cada tipo de recurso.

Política de actualización de AppStream 2.0

Para detener una flota de AppStream 2.0 antes de comenzar una actualización y reiniciarla cuando finalice, utilice la política de actualización de AppStream 2.0.

Sintaxis

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

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

Política AutoScalingReplacingUpdate

Para sustituir un grupo de escalado automático y las instancias que contiene, utilice la política AutoScalingReplacingUpdate.

Antes de realizar una actualización, asegúrese de que dispone de suficiente capacidad de Amazon EC2 tanto para los grupos de Auto Scaling antiguos como los nuevos.

Sintaxis

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

UpdatePolicy:
  AutoScalingReplacingUpdate:
    WillReplace: Boolean

Propiedades

Política AutoScalingRollingUpdate

Para realizar una actualización continua de las instancias en un grupo de escalado automático, en vez de esperar a que las actividades de escalado sustituyan de manera gradual las instancias previas con instancias nuevas, utilice la política AutoScalingRollingUpdate. Esta política brinda flexibilidad para especificar que CloudFormation sustituya por lotes las instancias de un grupo de escalado automático o de manera integral sin reemplazar el recurso en su totalidad.

Aspectos que tener en cuenta al utilizar una política de AutoScalingRollingUpdate:

Sintaxis

"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

Propiedades

Política AutoScalingScheduledAction

Para especificar la forma en que CloudFormation administra las actualizaciones de las propiedades MinSize, MaxSize y DesiredCapacity cuando el recurso AWS::AutoScaling::AutoScalingGroup tiene una acción programada asociada, utilice la política AutoScalingScheduledAction.

Con las acciones programadas, las propiedades de tamaño de un grupo de escalado automático pueden cambiar en cualquier momento. Al actualizar una pila con un grupo de escalado automático y una acción programada, CloudFormation siempre establece los valores de la propiedad del tamaño del grupo de escalado automático en los valores que se definen en el recurso AWS::AutoScaling::AutoScalingGroup de la plantilla, incluso si se está en vigor una acción programada.

Si no desea que CloudFormation cambie cualquiera de los valores de la propiedad de tamaño del grupo cuando hay en vigor una acción programada, utilice la política de actualización AutoScalingScheduledAction y configure IgnoreUnmodifiedGroupSizeProperties en true para evitar que CloudFormation cambie las propiedades MinSize, MaxSize o DesiredCapacity a menos que haya modificado estos valores en la plantilla.

Sintaxis

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

UpdatePolicy:
  AutoScalingScheduledAction:
    IgnoreUnmodifiedGroupSizeProperties: Boolean

Propiedades

Política UseOnlineResharding

Para modificar las particiones del grupo de replicación añadiendo o quitando particiones, en lugar de sustituir todo el recurso AWS::ElastiCache::ReplicationGroup, utilice la política de actualización de UseOnlineResharding.

Si UseOnlineResharding está establecido en true, puede actualizar las propiedades NumNodeGroups y NodeGroupConfiguration del recurso AWS::ElastiCache::ReplicationGroup y CloudFormation actualizará esas propiedades sin interrupción. Cuando UseOnlineResharding se establece en false o no se especifica, la actualización de las propiedades NumNodeGroups y NodeGroupConfiguration tendrá como resultado que CloudFormation sustituya todo el recursoAWS::ElastiCache::ReplicationGroup.

La política de actualización UseOnlineResharding no tiene propiedades.

Aspectos a tener en cuenta a la hora de establecer la política de actualización UseOnlineResharding en true:

Para obtener más información acerca de la modificación de los grupos de replicación, consulte ModifyReplicationGroupShardConfiguration en la Amazon ElastiCache API Reference.

Sintaxis

"UpdatePolicy" : {
  "UseOnlineResharding" : Boolean
}

UpdatePolicy:
  UseOnlineResharding: Boolean

Política EnableVersionUpgrade

Para actualizar un dominio de OpenSearch Service a una nueva versión de OpenSearch o Elasticsearch, en lugar de reemplazar todo el recurso AWS::OpenSearchService::Domain o el recurso AWS::Elasticsearch::Domain, utilice la política de actualización EnableVersionUpgrade.

Si EnableVersionUpgrade se establece en true, puede actualizar la propiedad EngineVersion del recurso AWS::OpenSearchService::Domain (o la propiedad ElasticsearchVersion del recurso AWS::Elasticsearch::Domain heredado) y CloudFormation actualizará dicha propiedad sin interrupción. Cuando EnableVersionUpgrade se establece en false o no se especifica, la actualización de los resultados de la propiedad EngineVersion o ElasticsearchVersion hará que CloudFormation sustituya todo el recurso AWS::OpenSearchService::Domain/AWS::Elasticsearch::Domain.

La política de actualización EnableVersionUpgrade no tiene propiedades.

Para obtener más información sobre la actualización de los dominios de OpenSearch Service, consulte UpgradeDomain en la Guía para desarrolladores de Amazon OpenSearch Service.

Sintaxis

"UpdatePolicy" : {
  "EnableVersionUpgrade" : Boolean
}

UpdatePolicy:
  EnableVersionUpgrade: Boolean

Política CodeDeployLambdaAliasUpdate

Para realizar una implementación de CodeDeploy cuando la versión cambia en un recurso AWS::Lambda::Alias, utilice la política de actualización CodeDeployLambdaAliasUpdate.

Sintaxis

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

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

Propiedades

Para conocer un ejemplo que especifique el atributo UpdatePolicy de un recurso AWS::Lambda::Alias, consulte Política de actualización de alias de Lambda.

Ejemplos

Los siguientes ejemplos muestran cómo añadir una política de actualización a un grupo de escalado automático y cómo mantener la disponibilidad a la hora de actualizar los metadatos.

Agregue una UpdatePolicy a un grupo de escalado grupo de escalado automático

En el ejemplo siguiente, se muestra cómo añadir una política de actualización. Durante una actualización, el grupo de escalado automático actualiza instancias en lotes de dos y mantiene un mínimo de una instancia en servicio. Dado que la marca WaitOnResourceSignals está establecida, el grupo de escalado automático espera a que se añadan nuevas instancias al grupo. Las nuevas instancias deben señalizar el grupo de escalado automático antes de actualizar el siguiente lote de instancias.

"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

Política AutoScalingReplacingUpdate

El siguiente ejemplo declara una política que obliga a sustituir un grupo de escalado automático asociado durante una actualización. Para que la actualización se realice correctamente, un porcentaje de instancias (especificadas por el parámetro MinSuccessfulPercentParameter) debe señalizar el éxito en el periodo de 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'

Mantener la disponibilidad al actualizar los metadatos para el script auxiliar cfn-init

Al instalar aplicaciones de software en las instancias, puede utilizar la clave de metadatos AWS::CloudFormation::Init y el script auxiliar cfn-init para el proceso de arranque de las instancias en el grupo de escalado automático. CloudFormation instala los paquetes, ejecuta los comandos y realiza otras acciones del proceso de arranque que se describen en los metadatos.

Al actualizar solo los metadatos (por ejemplo, cuando se actualiza un paquete a otra versión), puede utilizar el daemon auxiliar cfn-hup para detectar y aplicar las actualizaciones. Sin embargo, el daemon cfn-hup se ejecuta de forma independiente en cada instancia. Si el daemon se ejecuta al mismo tiempo en todas las instancias, su aplicación o servicio podría no estar disponible durante la actualización. Para garantizar la disponibilidad, puede forzar una actualización acumulativa para que CloudFormation actualice sus instancias de lote en lote.

Para forzar una actualización acumulativa, cambie el ID lógico del recurso de configuración de lanzamiento y, a continuación, actualice la pila y todas las referencias que apuntan al ID de lógica original (como el grupo de escalado automático asociado). CloudFormation desencadena una actualización acumulativa en el grupo de escalado automático y sustituye todas las instancias.

Plantilla original

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

ID lógico actualizado

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

Política de actualización de alias de Lambda

El siguiente ejemplo especifica el atributo UpdatePolicy para un recurso AWS::Lambda::Alias. Todos los detalles de la implementación se definen mediante el grupo de implementación y la aplicación que se transfieren a la política.

"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