describe_stack_drift_detection_status

CloudFormation.Client.describe_stack_drift_detection_status(**kwargs)

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 it's 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 Detecting Unregulated Configuration Changes to Stacks and Resources.

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_stack_drift_detection_status(
    StackDriftDetectionId='string'
)

Parameters

StackDriftDetectionId (string) --

[REQUIRED]

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.

Return type

dict

Returns

Response Syntax

{
    'StackId': 'string',
    'StackDriftDetectionId': 'string',
    'StackDriftStatus': 'DRIFTED'|'IN_SYNC'|'UNKNOWN'|'NOT_CHECKED',
    'DetectionStatus': 'DETECTION_IN_PROGRESS'|'DETECTION_FAILED'|'DETECTION_COMPLETE',
    'DetectionStatusReason': 'string',
    'DriftedStackResourceCount': 123,
    'Timestamp': datetime(2015, 1, 1)
}

Response Structure

• (dict) --
  • StackId (string) --

    The ID of the stack.

  • StackDriftDetectionId (string) --

    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.

  • StackDriftStatus (string) --

    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 : This value is reserved for future use.
  • DetectionStatus (string) --

    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.
  • DetectionStatusReason (string) --

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

  • DriftedStackResourceCount (integer) --

    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 .

  • Timestamp (datetime) --

    Time at which the stack drift detection operation was initiated.