CANCELUPDATE()`¶

About CancelUpdate¶

Cancels an in-progress update to an Amazon EKS cluster on a best-effort basis. Cancellation is only performed if the update can be cancelled. Currently, this is supported for VersionRollback update types on EKS Auto Mode clusters when nodes are rolling back.

A successful cancellation stops the node rollback. After cancellation, nodes converge to the current cluster version honoring configured disruption controls. If the control plane rollback has already begun, the cancellation request fails.

Method Signature¶

METHODS /AWS1/IF_EKS~CANCELUPDATE
  IMPORTING
    !IV_NAME TYPE /AWS1/EKSSTRING OPTIONAL
    !IV_UPDATEID TYPE /AWS1/EKSSTRING OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/EKSSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ekscancelupdatersp
  RAISING
    /AWS1/CX_EKSCLIENTEXCEPTION
    /AWS1/CX_EKSINVALIDPARAMETEREX
    /AWS1/CX_EKSINVALIDREQUESTEX
    /AWS1/CX_EKSINVALIDSTATEEX
    /AWS1/CX_EKSRESOURCEINUSEEX
    /AWS1/CX_EKSRESOURCENOTFOUNDEX
    /AWS1/CX_EKSSERVEREXCEPTION
    /AWS1/CX_EKSTHROTTLINGEX
    /AWS1/CX_EKSCLIENTEXC
    /AWS1/CX_EKSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/EKSSTRING` `/AWS1/EKSSTRING`¶

The name of the Amazon EKS cluster associated with the update.

`iv_updateid` `TYPE /AWS1/EKSSTRING` `/AWS1/EKSSTRING`¶

The ID of the update to cancel.

Optional arguments:¶

`iv_clientrequesttoken` `TYPE /AWS1/EKSSTRING` `/AWS1/EKSSTRING`¶

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ekscancelupdatersp` `/AWS1/CL_EKSCANCELUPDATERSP`¶

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->cancelupdate(
  iv_clientrequesttoken = |string|
  iv_name = |string|
  iv_updateid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_update = lo_result->get_update( ).
  IF lo_update IS NOT INITIAL.
    lv_string = lo_update->get_id( ).
    lv_updatestatus = lo_update->get_status( ).
    lv_updatetype = lo_update->get_type( ).
    LOOP AT lo_update->get_params( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_updateparamtype = lo_row_1->get_type( ).
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_timestamp = lo_update->get_createdat( ).
    LOOP AT lo_update->get_errors( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_errorcode = lo_row_3->get_errorcode( ).
        lv_string = lo_row_3->get_errormessage( ).
        LOOP AT lo_row_3->get_resourceids( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_string = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
    lo_cancellation = lo_update->get_cancellation( ).
    IF lo_cancellation IS NOT INITIAL.
      lv_cancellationstatus = lo_cancellation->get_status( ).
      lv_string = lo_cancellation->get_reason( ).
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_EKS=>CANCELUPDATE()¶