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.Types.StackResourceDrift

Description

 
Synopsis

Documentation

data StackResourceDrift Source #

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Resources that don't currently support drift detection can't be checked. 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 resources in a given stack that support drift detection.

See: newStackResourceDrift smart constructor.

Constructors

StackResourceDrift' 

Fields

  • actualProperties :: Maybe Text

    A JSON structure containing the actual property values of the stack resource.

    For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

  • expectedProperties :: Maybe Text

    A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

    For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

  • moduleInfo :: Maybe ModuleInfo

    Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

  • physicalResourceId :: Maybe Text

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

  • physicalResourceIdContext :: Maybe [PhysicalResourceIdContextKeyValuePair]

    Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

  • propertyDifferences :: Maybe [PropertyDifference]

    A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

  • stackId :: Text

    The ID of the stack.

  • logicalResourceId :: Text

    The logical name of the resource specified in the template.

  • resourceType :: Text

    The type of the resource.

  • stackResourceDriftStatus :: StackResourceDriftStatus

    Status of the resource's actual configuration compared to its expected configuration.

    • DELETED: The resource differs from its expected template configuration because the resource has been deleted.
    • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).
    • IN_SYNC: The resource's actual configuration matches its expected template configuration.
    • NOT_CHECKED: CloudFormation does not currently return this value.
  • timestamp :: ISO8601

    Time at which CloudFormation performed drift detection on the stack resource.

Instances

Instances details
FromXML StackResourceDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackResourceDrift

Generic StackResourceDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackResourceDrift

Associated Types

type Rep StackResourceDrift :: Type -> Type #

Read StackResourceDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackResourceDrift

Show StackResourceDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackResourceDrift

NFData StackResourceDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackResourceDrift

Methods

rnf :: StackResourceDrift -> () #

Eq StackResourceDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackResourceDrift

Hashable StackResourceDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackResourceDrift

type Rep StackResourceDrift Source # 
Instance details

Defined in Amazonka.CloudFormation.Types.StackResourceDrift

type Rep StackResourceDrift = D1 ('MetaData "StackResourceDrift" "Amazonka.CloudFormation.Types.StackResourceDrift" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "StackResourceDrift'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "actualProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "expectedProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "moduleInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModuleInfo)) :*: (S1 ('MetaSel ('Just "physicalResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "physicalResourceIdContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhysicalResourceIdContextKeyValuePair]))))) :*: ((S1 ('MetaSel ('Just "propertyDifferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PropertyDifference])) :*: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "logicalResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "stackResourceDriftStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 StackResourceDriftStatus) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))))))

newStackResourceDrift Source #

Create a value of StackResourceDrift 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:actualProperties:StackResourceDrift', stackResourceDrift_actualProperties - A JSON structure containing the actual property values of the stack resource.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

$sel:expectedProperties:StackResourceDrift', stackResourceDrift_expectedProperties - A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

$sel:moduleInfo:StackResourceDrift', stackResourceDrift_moduleInfo - Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

$sel:physicalResourceId:StackResourceDrift', stackResourceDrift_physicalResourceId - The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

$sel:physicalResourceIdContext:StackResourceDrift', stackResourceDrift_physicalResourceIdContext - Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

$sel:propertyDifferences:StackResourceDrift', stackResourceDrift_propertyDifferences - A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

$sel:stackId:StackResourceDrift', stackResourceDrift_stackId - The ID of the stack.

$sel:logicalResourceId:StackResourceDrift', stackResourceDrift_logicalResourceId - The logical name of the resource specified in the template.

$sel:resourceType:StackResourceDrift', stackResourceDrift_resourceType - The type of the resource.

$sel:stackResourceDriftStatus:StackResourceDrift', stackResourceDrift_stackResourceDriftStatus - Status of the resource's actual configuration compared to its expected configuration.

  • DELETED: The resource differs from its expected template configuration because the resource has been deleted.
  • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).
  • IN_SYNC: The resource's actual configuration matches its expected template configuration.
  • NOT_CHECKED: CloudFormation does not currently return this value.

$sel:timestamp:StackResourceDrift', stackResourceDrift_timestamp - Time at which CloudFormation performed drift detection on the stack resource.

stackResourceDrift_actualProperties :: Lens' StackResourceDrift (Maybe Text) Source #

A JSON structure containing the actual property values of the stack resource.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

stackResourceDrift_expectedProperties :: Lens' StackResourceDrift (Maybe Text) Source #

A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

stackResourceDrift_moduleInfo :: Lens' StackResourceDrift (Maybe ModuleInfo) Source #

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

stackResourceDrift_physicalResourceId :: Lens' StackResourceDrift (Maybe Text) Source #

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

stackResourceDrift_physicalResourceIdContext :: Lens' StackResourceDrift (Maybe [PhysicalResourceIdContextKeyValuePair]) Source #

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

stackResourceDrift_propertyDifferences :: Lens' StackResourceDrift (Maybe [PropertyDifference]) Source #

A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

stackResourceDrift_logicalResourceId :: Lens' StackResourceDrift Text Source #

The logical name of the resource specified in the template.

stackResourceDrift_stackResourceDriftStatus :: Lens' StackResourceDrift StackResourceDriftStatus Source #

Status of the resource's actual configuration compared to its expected configuration.

  • DELETED: The resource differs from its expected template configuration because the resource has been deleted.
  • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).
  • IN_SYNC: The resource's actual configuration matches its expected template configuration.
  • NOT_CHECKED: CloudFormation does not currently return this value.

stackResourceDrift_timestamp :: Lens' StackResourceDrift UTCTime Source #

Time at which CloudFormation performed drift detection on the stack resource.