MODIFYGLOBALCLUSTER()`¶

About ModifyGlobalCluster¶

Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_globalclusteridentifier` `TYPE /AWS1/NEPGLOBALCLUSTERID` `/AWS1/NEPGLOBALCLUSTERID`¶

The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

Constraints: Must match the identifier of an existing global database cluster.

Optional arguments:¶

`iv_newglobalclusterid` `TYPE /AWS1/NEPGLOBALCLUSTERID` `/AWS1/NEPGLOBALCLUSTERID`¶

A new cluster identifier to assign to the global database. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.

The first character must be a letter.

Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

`iv_deletionprotection` `TYPE /AWS1/NEPBOOLEANOPTIONAL` `/AWS1/NEPBOOLEANOPTIONAL`¶

Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.

`iv_engineversion` `TYPE /AWS1/NEPSTRING` `/AWS1/NEPSTRING`¶

The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available Neptune engine versions, use the following command:

`iv_allowmajorversionupgrade` `TYPE /AWS1/NEPBOOLEANOPTIONAL` `/AWS1/NEPBOOLEANOPTIONAL`¶

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades if you specify a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_nepmodifyglbclustrslt` `/AWS1/CL_NEPMODIFYGLBCLUSTRSLT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->/aws1/if_nep~modifyglobalcluster(
  iv_allowmajorversionupgrade = ABAP_TRUE
  iv_deletionprotection = ABAP_TRUE
  iv_engineversion = |string|
  iv_globalclusteridentifier = |string|
  iv_newglobalclusterid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_globalcluster = lo_result->get_globalcluster( ).
  IF lo_globalcluster IS NOT INITIAL.
    lv_globalclusteridentifier = lo_globalcluster->get_globalclusteridentifier( ).
    lv_string = lo_globalcluster->get_globalclusterresourceid( ).
    lv_string = lo_globalcluster->get_globalclusterarn( ).
    lv_string = lo_globalcluster->get_status( ).
    lv_string = lo_globalcluster->get_engine( ).
    lv_string = lo_globalcluster->get_engineversion( ).
    lv_booleanoptional = lo_globalcluster->get_storageencrypted( ).
    lv_booleanoptional = lo_globalcluster->get_deletionprotection( ).
    LOOP AT lo_globalcluster->get_globalclustermembers( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_dbclusterarn( ).
        LOOP AT lo_row_1->get_readers( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_string = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_boolean = lo_row_1->get_iswriter( ).
      ENDIF.
    ENDLOOP.
    lo_failoverstate = lo_globalcluster->get_failoverstate( ).
    IF lo_failoverstate IS NOT INITIAL.
      lv_failoverstatus = lo_failoverstate->get_status( ).
      lv_string = lo_failoverstate->get_fromdbclusterarn( ).
      lv_string = lo_failoverstate->get_todbclusterarn( ).
      lv_boolean = lo_failoverstate->get_isdatalossallowed( ).
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/CL_NEP=>MODIFYGLOBALCLUSTER()¶