CANCELINSTANCEREFRESH()`¶

About CancelInstanceRefresh¶

Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs.

This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.

Method Signature¶

METHODS /AWS1/IF_ASC~CANCELINSTANCEREFRESH
  IMPORTING
    !IV_AUTOSCALINGGROUPNAME TYPE /AWS1/ASCXMLSTRINGMAXLEN255 OPTIONAL
    !IV_WAITFORTRANSINGINSTANCES TYPE /AWS1/ASCBOOLEANTYPE OPTIONAL
  PREFERRED PARAMETER iv_autoscalinggroupname
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_asccancinstrefresha00
  RAISING
    /AWS1/CX_ASCACTINSTREFRESHNO00
    /AWS1/CX_ASCLIMITEXCEEDEDFAULT
    /AWS1/CX_ASCRESRCCONTIONFAULT
    /AWS1/CX_ASCCLIENTEXC
    /AWS1/CX_ASCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_autoscalinggroupname` `TYPE /AWS1/ASCXMLSTRINGMAXLEN255` `/AWS1/ASCXMLSTRINGMAXLEN255`¶

The name of the Auto Scaling group.

Optional arguments:¶

`iv_waitfortransinginstances` `TYPE /AWS1/ASCBOOLEANTYPE` `/AWS1/ASCBOOLEANTYPE`¶

When cancelling an instance refresh, this indicates whether to wait for in-flight launches and terminations to complete. The default is true.

When set to false, Amazon EC2 Auto Scaling cancels the instance refresh without waiting for any pending launches or terminations to complete.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_asccancinstrefresha00` `/AWS1/CL_ASCCANCINSTREFRESHA00`¶

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->cancelinstancerefresh(
  iv_autoscalinggroupname = |string|
  iv_waitfortransinginstances = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_xmlstringmaxlen255 = lo_result->get_instancerefreshid( ).
ENDIF.

To cancel an instance refresh¶

This example cancels an instance refresh operation in progress.

DATA(lo_result) = lo_client->cancelinstancerefresh( iv_autoscalinggroupname = |my-auto-scaling-group| ) .

/AWS1/IF_ASC=>CANCELINSTANCEREFRESH()¶