Skip to content

Detect Stack Set Drift

cloudformation_detect_stack_set_drift R Documentation

Detect drift on a StackSet

Description

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

detect_stack_set_drift returns the OperationId of the StackSet drift detection operation. Use this operation id with describe_stack_set_operation 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 StackSet, 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 describe_stack_set to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the StackSet. (Information about drift operations that are in progress isn't included.)

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

  • Use describe_stack_instance 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 StackSet at one time.

To stop a drift detection StackSet operation, use stop_stack_set_operation.

Usage

cloudformation_detect_stack_set_drift(StackSetName,
  OperationPreferences, OperationId, CallAs)

Arguments

StackSetName

[required] The name of the StackSet on which to perform the drift detection operation.
OperationPreferences

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

For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
OperationId

The ID of the StackSet operation.
CallAs

[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.

Value

A list with the following syntax:

list(
  OperationId = "string"
)

Request syntax

svc$detect_stack_set_drift(
  StackSetName = "string",
  OperationPreferences = list(
    RegionConcurrencyType = "SEQUENTIAL"|"PARALLEL",
    RegionOrder = list(
      "string"
    ),
    FailureToleranceCount = 123,
    FailureTolerancePercentage = 123,
    MaxConcurrentCount = 123,
    MaxConcurrentPercentage = 123,
    ConcurrencyMode = "STRICT_FAILURE_TOLERANCE"|"SOFT_FAILURE_TOLERANCE"
  ),
  OperationId = "string",
  CallAs = "SELF"|"DELEGATED_ADMIN"
)