Skip to content

/AWS1/CL_FRM=>CREATESTACKINSTANCES()

About CreateStackInstances

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

Method Signature

IMPORTING

Required arguments:

iv_stacksetname TYPE /AWS1/FRMSTACKSETNAME /AWS1/FRMSTACKSETNAME

The name or unique ID of the stack set that you want to create stack instances from.

it_regions TYPE /AWS1/CL_FRMREGIONLIST_W=>TT_REGIONLIST TT_REGIONLIST

The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified Amazon Web Services accounts.

Optional arguments:

it_accounts TYPE /AWS1/CL_FRMACCOUNTLIST_W=>TT_ACCOUNTLIST TT_ACCOUNTLIST

[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) 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 for which to create stack instances in the specified Amazon Web Services Regions.

You can specify Accounts or DeploymentTargets, but not both.

it_parameteroverrides TYPE /AWS1/CL_FRMPARAMETER=>TT_PARAMETERS TT_PARAMETERS

A list of stack set parameters whose values you want to override in the selected stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values during stack instance operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave an overridden parameter set to its present value, include the parameter and specify UsePreviousValue as true. (You can't specify both a value and set UsePreviousValue to true.)

  • To set an overridden parameter back to the value specified in the stack set, specify a parameter list but don't include the parameter in the list.

  • To leave all parameters set to their present values, don't specify this property at all.

During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

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

Preferences for how CloudFormation performs this stack set operation.

iv_operationid TYPE /AWS1/FRMCLIENTREQUESTTOKEN /AWS1/FRMCLIENTREQUESTTOKEN

The unique identifier for this stack set operation.

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

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

Repeating this stack set 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 stack sets 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_frmcrestackinstsout /AWS1/CL_FRMCRESTACKINSTSOUT

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~createstackinstances(
  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_parameteroverrides = VALUE /aws1/cl_frmparameter=>tt_parameters(
    (
      new /aws1/cl_frmparameter(
        iv_parameterkey = |string|
        iv_parametervalue = |string|
        iv_resolvedvalue = |string|
        iv_usepreviousvalue = ABAP_TRUE
      )
    )
  )
  it_regions = VALUE /aws1/cl_frmregionlist_w=>tt_regionlist(
    ( new /aws1/cl_frmregionlist_w( |string| ) )
  )
  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.
  lv_clientrequesttoken = lo_result->get_operationid( ).
ENDIF.