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

Description

Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects configuration drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

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

Synopsis

Creating a Request

data DescribeStackResourceDrifts Source #

See: newDescribeStackResourceDrifts smart constructor.

Constructors

DescribeStackResourceDrifts' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

  • nextToken :: Maybe Text

    A string that identifies the next page of stack resource drift results.

  • stackResourceDriftStatusFilters :: Maybe (NonEmpty StackResourceDriftStatus)

    The resource drift status values to use as filters for the resource drift results returned.

    • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
    • MODIFIED: One or more resource properties differ from their expected template values.
    • IN_SYNC: The resource's actual configuration matches its expected template configuration.
    • NOT_CHECKED: CloudFormation doesn't currently return this value.
  • stackName :: Text

    The name of the stack for which you want drift information.

Instances

Instances details
ToHeaders DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

ToPath DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

ToQuery DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

AWSRequest DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

Generic DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

Associated Types

type Rep DescribeStackResourceDrifts :: Type -> Type #

Read DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

Show DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

NFData DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

Eq DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

Hashable DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

type AWSResponse DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

type Rep DescribeStackResourceDrifts Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

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

newDescribeStackResourceDrifts Source #

Create a value of DescribeStackResourceDrifts 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:maxResults:DescribeStackResourceDrifts', describeStackResourceDrifts_maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

DescribeStackResourceDrifts, describeStackResourceDrifts_nextToken - A string that identifies the next page of stack resource drift results.

$sel:stackResourceDriftStatusFilters:DescribeStackResourceDrifts', describeStackResourceDrifts_stackResourceDriftStatusFilters - The resource drift status values to use as filters for the resource drift results returned.

  • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
  • MODIFIED: One or more resource properties differ from their expected template values.
  • IN_SYNC: The resource's actual configuration matches its expected template configuration.
  • NOT_CHECKED: CloudFormation doesn't currently return this value.

DescribeStackResourceDrifts, describeStackResourceDrifts_stackName - The name of the stack for which you want drift information.

Request Lenses

describeStackResourceDrifts_maxResults :: Lens' DescribeStackResourceDrifts (Maybe Natural) Source #

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

describeStackResourceDrifts_nextToken :: Lens' DescribeStackResourceDrifts (Maybe Text) Source #

A string that identifies the next page of stack resource drift results.

describeStackResourceDrifts_stackResourceDriftStatusFilters :: Lens' DescribeStackResourceDrifts (Maybe (NonEmpty StackResourceDriftStatus)) Source #

The resource drift status values to use as filters for the resource drift results returned.

  • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.
  • MODIFIED: One or more resource properties differ from their expected template values.
  • IN_SYNC: The resource's actual configuration matches its expected template configuration.
  • NOT_CHECKED: CloudFormation doesn't currently return this value.

describeStackResourceDrifts_stackName :: Lens' DescribeStackResourceDrifts Text Source #

The name of the stack for which you want drift information.

Destructuring the Response

data DescribeStackResourceDriftsResponse Source #

Constructors

DescribeStackResourceDriftsResponse' 

Fields

  • nextToken :: Maybe Text

    If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

  • httpStatus :: Int

    The response's http status code.

  • stackResourceDrifts :: [StackResourceDrift]

    Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.

    For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

Instances

Instances details
Generic DescribeStackResourceDriftsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

Read DescribeStackResourceDriftsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

Show DescribeStackResourceDriftsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

NFData DescribeStackResourceDriftsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

Eq DescribeStackResourceDriftsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

type Rep DescribeStackResourceDriftsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResourceDrifts

type Rep DescribeStackResourceDriftsResponse = D1 ('MetaData "DescribeStackResourceDriftsResponse" "Amazonka.CloudFormation.DescribeStackResourceDrifts" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeStackResourceDriftsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "stackResourceDrifts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [StackResourceDrift]))))

newDescribeStackResourceDriftsResponse Source #

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

DescribeStackResourceDrifts, describeStackResourceDriftsResponse_nextToken - If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

$sel:httpStatus:DescribeStackResourceDriftsResponse', describeStackResourceDriftsResponse_httpStatus - The response's http status code.

$sel:stackResourceDrifts:DescribeStackResourceDriftsResponse', describeStackResourceDriftsResponse_stackResourceDrifts - Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

Response Lenses

describeStackResourceDriftsResponse_nextToken :: Lens' DescribeStackResourceDriftsResponse (Maybe Text) Source #

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

describeStackResourceDriftsResponse_stackResourceDrifts :: Lens' DescribeStackResourceDriftsResponse [StackResourceDrift] Source #

Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where CloudFormation detects drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently support drift detection aren't checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.