UPGRADEELASTICSEARCHDOMAIN()`¶

About UpgradeElasticsearchDomain¶

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Method Signature¶

METHODS /AWS1/IF_ESS~UPGRADEELASTICSEARCHDOMAIN
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/ESSDOMAINNAME OPTIONAL
    !IV_TARGETVERSION TYPE /AWS1/ESSELASTICSRCHVRSSTRING OPTIONAL
    !IV_PERFORMCHECKONLY TYPE /AWS1/ESSBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_essupgradeelasticsr01
  RAISING
    /AWS1/CX_ESSBASEEXCEPTION
    /AWS1/CX_ESSDISABLEDOPEX
    /AWS1/CX_ESSINTERNALEXCEPTION
    /AWS1/CX_ESSRESRCALRDYEXISTSEX
    /AWS1/CX_ESSRESOURCENOTFOUNDEX
    /AWS1/CX_ESSVALIDATIONEX
    /AWS1/CX_ESSCLIENTEXC
    /AWS1/CX_ESSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_domainname` `TYPE /AWS1/ESSDOMAINNAME` `/AWS1/ESSDOMAINNAME`¶

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

`iv_targetversion` `TYPE /AWS1/ESSELASTICSRCHVRSSTRING` `/AWS1/ESSELASTICSRCHVRSSTRING`¶

The version of Elasticsearch that you intend to upgrade the domain to.

Optional arguments:¶

`iv_performcheckonly` `TYPE /AWS1/ESSBOOLEAN` `/AWS1/ESSBOOLEAN`¶

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_essupgradeelasticsr01` `/AWS1/CL_ESSUPGRADEELASTICSR01`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->upgradeelasticsearchdomain(
  iv_domainname = |string|
  iv_performcheckonly = ABAP_TRUE
  iv_targetversion = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_domainname = lo_result->get_domainname( ).
  lv_elasticsearchversionstr = lo_result->get_targetversion( ).
  lv_boolean = lo_result->get_performcheckonly( ).
  lo_changeprogressdetails = lo_result->get_changeprogressdetails( ).
  IF lo_changeprogressdetails IS NOT INITIAL.
    lv_guid = lo_changeprogressdetails->get_changeid( ).
    lv_message = lo_changeprogressdetails->get_message( ).
    lv_configchangestatus = lo_changeprogressdetails->get_configchangestatus( ).
    lv_updatetimestamp = lo_changeprogressdetails->get_starttime( ).
    lv_updatetimestamp = lo_changeprogressdetails->get_lastupdatedtime( ).
    lv_initiatedby = lo_changeprogressdetails->get_initiatedby( ).
  ENDIF.
ENDIF.

/AWS1/IF_ESS=>UPGRADEELASTICSEARCHDOMAIN()¶