Skip to content

/AWS1/IF_FRM=>DELETESTACKINSTANCES()

About DeleteStackInstances

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

The maximum number of organizational unit (OUs) supported by a DeleteStackInstances operation is 50.

If you need more than 50, consider the following options:

  • Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each.

  • Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desired child OUs.

Method Signature

IMPORTING

Required arguments:

iv_stacksetname TYPE /AWS1/FRMSTACKSETNAME /AWS1/FRMSTACKSETNAME

The name or unique ID of the StackSet that you want to delete stack instances for.

it_regions TYPE /AWS1/CL_FRMREGIONLIST_W=>TT_REGIONLIST TT_REGIONLIST

The Amazon Web Services Regions where you want to delete StackSet instances.

iv_retainstacks TYPE /AWS1/FRMRETAINSTACKS /AWS1/FRMRETAINSTACKS

Removes the stack instances from the specified StackSet, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

For more information, see StackSet operation options.

Optional arguments:

it_accounts TYPE /AWS1/CL_FRMACCOUNTLIST_W=>TT_ACCOUNTLIST TT_ACCOUNTLIST

[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.

You can specify Accounts or DeploymentTargets, but not both.

io_deploymenttargets TYPE REF TO /AWS1/CL_FRMDEPLOYMENTTARGETS /AWS1/CL_FRMDEPLOYMENTTARGETS

[Service-managed permissions] The Organizations accounts from which to delete stack instances.

You can specify Accounts or DeploymentTargets, but not both.

io_operationpreferences TYPE REF TO /AWS1/CL_FRMSTACKSETOPPREFER00 /AWS1/CL_FRMSTACKSETOPPREFER00

Preferences for how CloudFormation performs this StackSet operation.

iv_operationid TYPE /AWS1/FRMCLIENTREQUESTTOKEN /AWS1/FRMCLIENTREQUESTTOKEN

The unique identifier for this StackSet operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the StackSet operation only once, even if you retry the request multiple times. You can retry StackSet operation requests to ensure that CloudFormation successfully received them.

Repeating this StackSet operation with a new operation ID retries all stack instances whose status is OUTDATED.

iv_callas TYPE /AWS1/FRMCALLAS /AWS1/FRMCALLAS

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

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_frmdelstackinstsout /AWS1/CL_FRMDELSTACKINSTSOUT

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_frm~deletestackinstances(
  io_deploymenttargets = new /aws1/cl_frmdeploymenttargets(
    it_accounts = VALUE /aws1/cl_frmaccountlist_w=>tt_accountlist(
      ( new /aws1/cl_frmaccountlist_w( |string| ) )
    )
    it_organizationalunitids = VALUE /aws1/cl_frmorgalunitidlist_w=>tt_organizationalunitidlist(
      ( new /aws1/cl_frmorgalunitidlist_w( |string| ) )
    )
    iv_accountfiltertype = |string|
    iv_accountsurl = |string|
  )
  io_operationpreferences = new /aws1/cl_frmstacksetopprefer00(
    it_regionorder = VALUE /aws1/cl_frmregionlist_w=>tt_regionlist(
      ( new /aws1/cl_frmregionlist_w( |string| ) )
    )
    iv_concurrencymode = |string|
    iv_failuretolerancecount = 123
    iv_failuretolerancepercent00 = 123
    iv_maxconcurrentcount = 123
    iv_maxconcurrentpercentage = 123
    iv_regionconcurrencytype = |string|
  )
  it_accounts = VALUE /aws1/cl_frmaccountlist_w=>tt_accountlist(
    ( new /aws1/cl_frmaccountlist_w( |string| ) )
  )
  it_regions = VALUE /aws1/cl_frmregionlist_w=>tt_regionlist(
    ( new /aws1/cl_frmregionlist_w( |string| ) )
  )
  iv_callas = |string|
  iv_operationid = |string|
  iv_retainstacks = ABAP_TRUE
  iv_stacksetname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_clientrequesttoken = lo_result->get_operationid( ).
ENDIF.