Skip to content

CloudFormation  >  Operations  >  describe_stack_drift_detection_status

describe_stack_drift_detection_status

Operation

describe_stack_drift_detection_status async 

describe_stack_drift_detection_status(input: DescribeStackDriftDetectionStatusInput, plugins: list[Plugin] | None = None) -> DescribeStackDriftDetectionStatusOutput

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information about stack and resource drift, see Detect unmanaged configuration changes to stacks and resources with drift detection.

Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

Parameters:

Name Type Description Default
input DescribeStackDriftDetectionStatusInput

An instance of DescribeStackDriftDetectionStatusInput.

 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
DescribeStackDriftDetectionStatusOutput

An instance of DescribeStackDriftDetectionStatusOutput.

Input

DescribeStackDriftDetectionStatusInput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackDriftDetectionStatusInput structure.

Attributes

stack_drift_detection_id class-attribute instance-attribute 
stack_drift_detection_id: str | None = ...

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results CloudFormation retains for any given stack, and for how long, may vary.

Output

DescribeStackDriftDetectionStatusOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeStackDriftDetectionStatusOutput structure.

Attributes

detection_status class-attribute instance-attribute 
detection_status: str | None = ...

The status of the stack drift detection operation.

  • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that don't currently support stack detection remain unchecked.)

If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

  • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

  • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

detection_status_reason class-attribute instance-attribute 
detection_status_reason: str | None = ...

The reason the stack drift detection operation has its current status.

drifted_stack_resource_count class-attribute instance-attribute 
drifted_stack_resource_count: int | None = ...

Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

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.

stack_drift_detection_id class-attribute instance-attribute 
stack_drift_detection_id: str | None = ...

The ID of the drift detection results of this operation.

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports CloudFormation retains for any given stack, and for how long, may vary.

stack_drift_status class-attribute instance-attribute 
stack_drift_status: str | None = ...

Status of the stack's actual configuration compared to its expected configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template configuration.

  • IN_SYNC: The stack's actual configuration matches its expected template configuration.

  • UNKNOWN: CloudFormation could not run drift detection for a resource in the stack. See the DetectionStatusReason for details.

stack_id class-attribute instance-attribute 
stack_id: str | None = ...

The ID of the stack.

timestamp class-attribute instance-attribute 
timestamp: datetime | None = ...

Time at which the stack drift detection operation was initiated.