¿Cómo realizo una actualización local o una actualización de reemplazo de mi recurso AWS::Elasticsearch::Domain en CloudFormation?

Descripción corta

Para habilitar una actualización local del recurso AWS::Elasticsearch::Domain, debe utilizar un atributo UpdatePolicy denominado EnableVersionUpgrade en la plantilla de CloudFormation. Puede utilizar la política EnableVersionUpgrade para habilitar o deshabilitar las actualizaciones locales de un dominio de Amazon OpenSearch Service.

Antes de realizar una actualización local o de reemplazo, tenga en cuenta lo siguiente:

• Amazon OpenSearch Service admite actualizaciones locales de OpenSearch Service para las versiones 5.1 o posteriores.
• Si cambia el valor de la propiedad EngineVersion durante una actualización de pila, CloudFormation realiza una actualización de reemplazo para un dominio de OpenSearch Service. A continuación, CloudFormation crea un nuevo dominio.
• Con una actualización local, puede hacer un seguimiento del historial de actualizaciones de su dominio y mantener la misma URL de punto de enlace de dominio. No tiene que hacer cambios en la configuración de los servicios que interactúan con el dominio. Estos servicios tendrán acceso a la nueva versión del dominio.
• Una actualización de reemplazo no permite realizar un seguimiento del historial de actualizaciones. El dominio antiguo se reemplaza por un dominio nuevo y una nueva URL de punto de enlace para ese dominio. Para permitir que los servicios que interactúan con el dominio accedan al nuevo dominio, debe hacer cambios en la configuración de sus servicios. Para más información, consulte Creación y administración de dominios de Amazon OpenSearch Service.

Resolución

1.    En la plantilla de pila de CloudFormation, agregue la política de actualización EnableVersionUpgrade.

2.    Para permitir que CloudFormation realice una actualización local, establezca EnableVersionUpgrade en verdadero y establezca ElasticsearchVersion en el valor de su versión.

-o bien-

Para reemplazar el recurso AWS::Elasticsearch::Domain por un nuevo recurso AWS::Elasticsearch::Domain, establezca EnableVersionUpgrade en falso o no especifique ningún valor.

Por ejemplo, el atributo UpdatePolicy se configura para una actualización local en la siguiente plantilla:

>AWSTemplateFormatVersion: 2010-09-09
Description: AWS CloudFormation sample template to launch an Amazon OpenSearch Service Domain. Performing an update using the same template and supplying a different ElasticsearchVersion will perform an in-place upgrade for an Elasticsearch Domain resource.
Parameters:
  ElasticsearchVersion:
    Type: String
    AllowedValues: ['5.6', '5.5', '5.3', '5.1', '6.8', '6.7', '6.5', '6.4', '6.3', '6.2', '6.0', '7.4', '7.1']
    Default: 5.3
    Description: The version of Amazon OpenSearch Service to use.
  InstanceTypeForDataNode:
    Type: String
    Default: m3.medium.elasticsearch
    Description: The instance type for your data nodes.
  NumberOfDataNodes:
    Type: String
    Default: 1
    Description: The number of data nodes (instances) to use in the OpenSearch Service domain.
Resources:
  ElasticSearchDomain:
    Type: AWS::Elasticsearch::Domain
    UpdatePolicy:
       EnableVersionUpgrade: true   ### In-place Upgrade
    Properties:
      ElasticsearchClusterConfig:
        InstanceCount: !Ref NumberOfDataNodes
        InstanceType: !Ref InstanceTypeForDataNode
      ElasticsearchVersion: !Ref ElasticsearchVersion

3.    Para completar el proceso de actualización local o actualización de reemplazo, actualice la pila mediante la consola de CloudFormation o AWS Command Line Interface (AWS CLI).

Información relacionada

Actualización de los dominios de Amazon OpenSearch Service