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.DetectStackDrift

Description

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. For each resource in the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.

For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.

DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.

Synopsis

Creating a Request

data DetectStackDrift Source #

See: newDetectStackDrift smart constructor.

Constructors

DetectStackDrift' 

Fields

Instances

Instances details
ToHeaders DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

ToPath DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

ToQuery DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

AWSRequest DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

Associated Types

type AWSResponse DetectStackDrift #

Generic DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

Associated Types

type Rep DetectStackDrift :: Type -> Type #

Read DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

Show DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

NFData DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

Methods

rnf :: DetectStackDrift -> () #

Eq DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

Hashable DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

type AWSResponse DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

type Rep DetectStackDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

type Rep DetectStackDrift = D1 ('MetaData "DetectStackDrift" "Amazonka.CloudFormation.DetectStackDrift" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DetectStackDrift'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logicalResourceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDetectStackDrift Source #

Create a value of DetectStackDrift 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:

DetectStackDrift, detectStackDrift_logicalResourceIds - The logical names of any resources you want to use as filters.

DetectStackDrift, detectStackDrift_stackName - The name of the stack for which you want to detect drift.

Request Lenses

detectStackDrift_logicalResourceIds :: Lens' DetectStackDrift (Maybe (NonEmpty Text)) Source #

The logical names of any resources you want to use as filters.

detectStackDrift_stackName :: Lens' DetectStackDrift Text Source #

The name of the stack for which you want to detect drift.

Destructuring the Response

data DetectStackDriftResponse Source #

See: newDetectStackDriftResponse smart constructor.

Constructors

DetectStackDriftResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • 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
Generic DetectStackDriftResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

Associated Types

type Rep DetectStackDriftResponse :: Type -> Type #

Read DetectStackDriftResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

Show DetectStackDriftResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

NFData DetectStackDriftResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

Eq DetectStackDriftResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

type Rep DetectStackDriftResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DetectStackDrift

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

newDetectStackDriftResponse Source #

Create a value of DetectStackDriftResponse 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:httpStatus:DetectStackDriftResponse', detectStackDriftResponse_httpStatus - The response's http status code.

$sel:stackDriftDetectionId:DetectStackDriftResponse', detectStackDriftResponse_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.

Response Lenses

detectStackDriftResponse_stackDriftDetectionId :: Lens' DetectStackDriftResponse 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.