detectStackSetDrift method

Future<DetectStackSetDriftOutput> detectStackSetDrift({ required String stackSetName, String? operationId, StackSetOperationPreferences? operationPreferences, })

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 How CloudFormation Performs Drift Detection on a Stack Set.

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, as well as 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 informaiton 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 is not 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.

For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets.

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 .

May throw InvalidOperationException. May throw OperationInProgressException. May throw StackSetNotFoundException.

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

Parameter operationId : The ID of the stack set operation.

Implementation

Future<DetectStackSetDriftOutput> detectStackSetDrift({
  required String stackSetName,
  String? operationId,
  StackSetOperationPreferences? operationPreferences,
}) async {
  ArgumentError.checkNotNull(stackSetName, 'stackSetName');
  _s.validateStringLength(
    'operationId',
    operationId,
    1,
    128,
  );
  final $request = <String, dynamic>{};
  $request['StackSetName'] = stackSetName;
  $request['OperationId'] = operationId ?? _s.generateIdempotencyToken();
  operationPreferences?.also((arg) => $request['OperationPreferences'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DetectStackSetDrift',
    version: '2010-05-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DetectStackSetDriftInput'],
    shapes: shapes,
    resultWrapper: 'DetectStackSetDriftResult',
  );
  return DetectStackSetDriftOutput.fromXml($result);
}