amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Description

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.

Synopsis

Creating a Request

data DescribeStackDriftDetectionStatus Source #

See: newDescribeStackDriftDetectionStatus smart constructor.

Constructors

DescribeStackDriftDetectionStatus' 

Fields

  • stackDriftDetectionId :: Text

    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.

Instances

Instances details
ToHeaders DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

ToPath DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

ToQuery DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

AWSRequest DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Generic DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Associated Types

type Rep DescribeStackDriftDetectionStatus :: Type -> Type #

Read DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Show DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

NFData DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Eq DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Hashable DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

type AWSResponse DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

type Rep DescribeStackDriftDetectionStatus Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

type Rep DescribeStackDriftDetectionStatus = D1 ('MetaData "DescribeStackDriftDetectionStatus" "Amazonka.CloudFormation.DescribeStackDriftDetectionStatus" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeStackDriftDetectionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stackDriftDetectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeStackDriftDetectionStatus Source #

Create a value of DescribeStackDriftDetectionStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeStackDriftDetectionStatus, describeStackDriftDetectionStatus_stackDriftDetectionId - 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.

Request Lenses

describeStackDriftDetectionStatus_stackDriftDetectionId :: Lens' DescribeStackDriftDetectionStatus Text Source #

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.

Destructuring the Response

data DescribeStackDriftDetectionStatusResponse Source #

Constructors

DescribeStackDriftDetectionStatusResponse' 

Fields

  • detectionStatusReason :: Maybe Text

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

  • driftedStackResourceCount :: Maybe Int

    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.

  • stackDriftStatus :: Maybe StackDriftStatus

    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.
  • httpStatus :: Int

    The response's http status code.

  • stackId :: Text

    The ID of the stack.

  • stackDriftDetectionId :: Text

    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.

  • detectionStatus :: StackDriftDetectionStatus

    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.
  • timestamp :: ISO8601

    Time at which the stack drift detection operation was initiated.

Instances

Instances details
Generic DescribeStackDriftDetectionStatusResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Read DescribeStackDriftDetectionStatusResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Show DescribeStackDriftDetectionStatusResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

NFData DescribeStackDriftDetectionStatusResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Eq DescribeStackDriftDetectionStatusResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

type Rep DescribeStackDriftDetectionStatusResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

type Rep DescribeStackDriftDetectionStatusResponse = D1 ('MetaData "DescribeStackDriftDetectionStatusResponse" "Amazonka.CloudFormation.DescribeStackDriftDetectionStatus" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeStackDriftDetectionStatusResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "detectionStatusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "driftedStackResourceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "stackDriftStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackDriftStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :*: ((S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stackDriftDetectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "detectionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StackDriftDetectionStatus) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))))

newDescribeStackDriftDetectionStatusResponse Source #

Create a value of DescribeStackDriftDetectionStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:detectionStatusReason:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_detectionStatusReason - The reason the stack drift detection operation has its current status.

$sel:driftedStackResourceCount:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_driftedStackResourceCount - 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.

DescribeStackDriftDetectionStatusResponse, describeStackDriftDetectionStatusResponse_stackDriftStatus - 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.

$sel:httpStatus:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_httpStatus - The response's http status code.

DescribeStackDriftDetectionStatusResponse, describeStackDriftDetectionStatusResponse_stackId - The ID of the stack.

DescribeStackDriftDetectionStatus, describeStackDriftDetectionStatusResponse_stackDriftDetectionId - 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.

$sel:detectionStatus:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_detectionStatus - 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.

DescribeStackDriftDetectionStatusResponse, describeStackDriftDetectionStatusResponse_timestamp - Time at which the stack drift detection operation was initiated.

Response Lenses

describeStackDriftDetectionStatusResponse_driftedStackResourceCount :: Lens' DescribeStackDriftDetectionStatusResponse (Maybe Int) Source #

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.

describeStackDriftDetectionStatusResponse_stackDriftStatus :: Lens' DescribeStackDriftDetectionStatusResponse (Maybe StackDriftStatus) Source #

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.

describeStackDriftDetectionStatusResponse_stackDriftDetectionId :: Lens' DescribeStackDriftDetectionStatusResponse Text Source #

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.

describeStackDriftDetectionStatusResponse_detectionStatus :: Lens' DescribeStackDriftDetectionStatusResponse StackDriftDetectionStatus Source #

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.