Skip to content

/AWS1/CL_FRM=>DETECTSTACKSETDRIFT()

About DetectStackSetDrift

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see Performing drift detection on CloudFormation StackSets.

DetectStackSetDrift returns the OperationId of the stack set drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.

Once the operation has completed, use the following actions to return drift information:

  • Use DescribeStackSet to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)

  • Use ListStackInstances to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.

  • Use DescribeStackInstance to return detailed information about a specific stack instance, including its drift status and last drift time checked.

You can only run a single drift detection operation on a given stack set at one time.

To stop a drift detection stack set operation, use StopStackSetOperation.

Method Signature

IMPORTING

Required arguments:

iv_stacksetname TYPE /AWS1/FRMSTACKSETNAMEORID /AWS1/FRMSTACKSETNAMEORID

The name of the stack set on which to perform the drift detection operation.

Optional arguments:

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

The user-specified preferences for how CloudFormation performs a stack set operation.

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

iv_operationid TYPE /AWS1/FRMCLIENTREQUESTTOKEN /AWS1/FRMCLIENTREQUESTTOKEN

The ID of the stack set operation.

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_frmdetectstacksetdr01 /AWS1/CL_FRMDETECTSTACKSETDR01

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~detectstacksetdrift(
  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|
  )
  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.