detect_stack_set_drift¶
Operation¶
async
¶
detect_stack_set_drift(input: DetectStackSetDriftInput, plugins: list[Plugin] | None = None) -> DetectStackSetDriftOutput
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.
DetectStackSetDrift returns the OperationId of the StackSet 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 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 DescribeStackSet 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 ListStackInstances to return a list of stack instances belonging to the StackSet, 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 StackSet at one time.
To stop a drift detection StackSet operation, use StopStackSetOperation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DetectStackSetDriftInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DetectStackSetDriftOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DetectStackSetDriftInput structure.
Attributes¶
class-attribute
instance-attribute
¶
call_as: str | None = ...
[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.
class-attribute
instance-attribute
¶
operation_id: str | None = ...
The ID of the StackSet operation.
class-attribute
instance-attribute
¶
operation_preferences: StackSetOperationPreferences | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DetectStackSetDriftOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
operation_id: str | None = ...
The ID of the drift detection StackSet operation.
You can use this operation ID with DescribeStackSetOperation to monitor the progress of the drift detection operation.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.