Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudFormation.DescribeStackDriftDetectionStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 on 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

Eq DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods (==) :: DescribeStackDriftDetectionStatus -> DescribeStackDriftDetectionStatus -> Bool # (/=) :: DescribeStackDriftDetectionStatus -> DescribeStackDriftDetectionStatus -> Bool #
Read DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods readsPrec :: Int -> ReadS DescribeStackDriftDetectionStatus # readList :: ReadS [DescribeStackDriftDetectionStatus] # readPrec :: ReadPrec DescribeStackDriftDetectionStatus # readListPrec :: ReadPrec [DescribeStackDriftDetectionStatus] #
Show DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods showsPrec :: Int -> DescribeStackDriftDetectionStatus -> ShowS # show :: DescribeStackDriftDetectionStatus -> String # showList :: [DescribeStackDriftDetectionStatus] -> ShowS #
Generic DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Associated Types type Rep DescribeStackDriftDetectionStatus :: Type -> Type # Methods from :: DescribeStackDriftDetectionStatus -> Rep DescribeStackDriftDetectionStatus x # to :: Rep DescribeStackDriftDetectionStatus x -> DescribeStackDriftDetectionStatus #
NFData DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods rnf :: DescribeStackDriftDetectionStatus -> () #
Hashable DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods hashWithSalt :: Int -> DescribeStackDriftDetectionStatus -> Int # hash :: DescribeStackDriftDetectionStatus -> Int #
AWSRequest DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Associated Types type AWSResponse DescribeStackDriftDetectionStatus # Methods request :: DescribeStackDriftDetectionStatus -> Request DescribeStackDriftDetectionStatus # response :: MonadResource m => Logger -> Service -> Proxy DescribeStackDriftDetectionStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStackDriftDetectionStatus))) #
ToHeaders DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods toHeaders :: DescribeStackDriftDetectionStatus -> [Header] #
ToPath DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods toPath :: DescribeStackDriftDetectionStatus -> ByteString #
ToQuery DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods toQuery :: DescribeStackDriftDetectionStatus -> QueryString #
type Rep DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus type Rep DescribeStackDriftDetectionStatus = D1 ('MetaData "DescribeStackDriftDetectionStatus" "Amazonka.CloudFormation.DescribeStackDriftDetectionStatus" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeStackDriftDetectionStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stackDriftDetectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeStackDriftDetectionStatus Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus type AWSResponse DescribeStackDriftDetectionStatus = DescribeStackDriftDetectionStatusResponse

newDescribeStackDriftDetectionStatus Source #

Arguments

:: Text	`$sel:stackDriftDetectionId:DescribeStackDriftDetectionStatus'`
-> DescribeStackDriftDetectionStatus

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:

$sel:stackDriftDetectionId: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 #

See: newDescribeStackDriftDetectionStatusResponse smart constructor.

Constructors

DescribeStackDriftDetectionStatusResponse'

Fields

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 has not 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.
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.
detectionStatusReason :: Maybe Text
The reason the stack drift detection operation has its current status.
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 do not 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

Eq DescribeStackDriftDetectionStatusResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods (==) :: DescribeStackDriftDetectionStatusResponse -> DescribeStackDriftDetectionStatusResponse -> Bool # (/=) :: DescribeStackDriftDetectionStatusResponse -> DescribeStackDriftDetectionStatusResponse -> Bool #
Read DescribeStackDriftDetectionStatusResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods readsPrec :: Int -> ReadS DescribeStackDriftDetectionStatusResponse # readList :: ReadS [DescribeStackDriftDetectionStatusResponse] # readPrec :: ReadPrec DescribeStackDriftDetectionStatusResponse # readListPrec :: ReadPrec [DescribeStackDriftDetectionStatusResponse] #
Show DescribeStackDriftDetectionStatusResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods showsPrec :: Int -> DescribeStackDriftDetectionStatusResponse -> ShowS # show :: DescribeStackDriftDetectionStatusResponse -> String # showList :: [DescribeStackDriftDetectionStatusResponse] -> ShowS #
Generic DescribeStackDriftDetectionStatusResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Associated Types type Rep DescribeStackDriftDetectionStatusResponse :: Type -> Type # Methods from :: DescribeStackDriftDetectionStatusResponse -> Rep DescribeStackDriftDetectionStatusResponse x # to :: Rep DescribeStackDriftDetectionStatusResponse x -> DescribeStackDriftDetectionStatusResponse #
NFData DescribeStackDriftDetectionStatusResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus Methods rnf :: DescribeStackDriftDetectionStatusResponse -> () #
type Rep DescribeStackDriftDetectionStatusResponse Source #
Instance details Defined in Amazonka.CloudFormation.DescribeStackDriftDetectionStatus type Rep DescribeStackDriftDetectionStatusResponse = D1 ('MetaData "DescribeStackDriftDetectionStatusResponse" "Amazonka.CloudFormation.DescribeStackDriftDetectionStatus" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeStackDriftDetectionStatusResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "stackDriftStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackDriftStatus)) :: S1 ('MetaSel ('Just "driftedStackResourceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "detectionStatusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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 #

Arguments

:: Int	`$sel:httpStatus:DescribeStackDriftDetectionStatusResponse'`
-> Text	`$sel:stackId:DescribeStackDriftDetectionStatusResponse'`
-> Text	`$sel:stackDriftDetectionId:DescribeStackDriftDetectionStatus'`
-> StackDriftDetectionStatus	`$sel:detectionStatus:DescribeStackDriftDetectionStatusResponse'`
-> UTCTime	`$sel:timestamp:DescribeStackDriftDetectionStatusResponse'`
-> DescribeStackDriftDetectionStatusResponse

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:stackDriftStatus: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 has not 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: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.

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

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

$sel:stackId:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_stackId - The ID of the stack.

$sel:stackDriftDetectionId: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 do not 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.

$sel:timestamp:DescribeStackDriftDetectionStatusResponse', describeStackDriftDetectionStatusResponse_timestamp - Time at which the stack drift detection operation was initiated.

Response Lenses

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 has not 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_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_detectionStatusReason :: Lens' DescribeStackDriftDetectionStatusResponse (Maybe Text) Source #

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

describeStackDriftDetectionStatusResponse_httpStatus :: Lens' DescribeStackDriftDetectionStatusResponse Int Source #

The response's http status code.

describeStackDriftDetectionStatusResponse_stackId :: Lens' DescribeStackDriftDetectionStatusResponse Text Source #

The ID of the stack.

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 do not 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_timestamp :: Lens' DescribeStackDriftDetectionStatusResponse UTCTime Source #

Time at which the stack drift detection operation was initiated.