STOPSTACKSETOPERATION()`¶

About StopStackSetOperation¶

Stops an in-progress operation on a StackSet and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.

Method Signature¶

METHODS /AWS1/IF_FRM~STOPSTACKSETOPERATION
  IMPORTING
    !IV_STACKSETNAME TYPE /AWS1/FRMSTACKSETNAME OPTIONAL
    !IV_OPERATIONID TYPE /AWS1/FRMCLIENTREQUESTTOKEN OPTIONAL
    !IV_CALLAS TYPE /AWS1/FRMCALLAS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_frmstopstacksetopout
  RAISING
    /AWS1/CX_FRMINVALIDOPERATIONEX
    /AWS1/CX_FRMOPNOTFOUNDEX
    /AWS1/CX_FRMSTACKSETNOTFOUNDEX
    /AWS1/CX_FRMCLIENTEXC
    /AWS1/CX_FRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_stacksetname` `TYPE /AWS1/FRMSTACKSETNAME` `/AWS1/FRMSTACKSETNAME`¶

The name or unique ID of the StackSet that you want to stop the operation for.

`iv_operationid` `TYPE /AWS1/FRMCLIENTREQUESTTOKEN` `/AWS1/FRMCLIENTREQUESTTOKEN`¶

The ID of the stack operation.

Optional arguments:¶

`iv_callas` `TYPE /AWS1/FRMCALLAS` `/AWS1/FRMCALLAS`¶

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid only if the StackSet uses service-managed permissions.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

If you are signed in to the management account, specify SELF.

If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_frmstopstacksetopout` `/AWS1/CL_FRMSTOPSTACKSETOPOUT`¶

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->stopstacksetoperation(
  iv_callas = |string|
  iv_operationid = |string|
  iv_stacksetname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_FRM=>STOPSTACKSETOPERATION()¶