Amazonka.CloudFormation.Types.ResourceChangeDetail

Documentation

data ResourceChangeDetail

For a resource with Modify as the action, the ResourceChange structure describes the changes CloudFormation will make to that resource.

See: newResourceChangeDetail smart constructor.

Constructors

ResourceChangeDetail'

Fields

• causingEntity :: Maybe Text

  The identity of the entity that triggered this change. This entity is a member of the group that's specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

  If the ChangeSource value is DirectModification, no value is given for CausingEntity.

• changeSource :: Maybe ChangeSource

  The group to which the CausingEntity value belongs. There are five entity groups:

  • ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.
  • ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.
  • ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.
  • DirectModification entities are changes that are made directly to the template.
  • Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent stack.
• evaluation :: Maybe EvaluationType

  Indicates whether CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

  For Static evaluations, CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

  For Dynamic evaluations, can't determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

• target :: Maybe ResourceTargetDefinition

  A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.

Instances

FromXML ResourceChangeDetail

Defined in Amazonka.CloudFormation.Types.ResourceChangeDetail

Methods

parseXML :: [Node] -> Either String ResourceChangeDetail

Generic ResourceChangeDetail

Defined in Amazonka.CloudFormation.Types.ResourceChangeDetail

Associated Types

type Rep ResourceChangeDetail :: Type -> Type

Methods

from :: ResourceChangeDetail -> Rep ResourceChangeDetail x

to :: Rep ResourceChangeDetail x -> ResourceChangeDetail

Read ResourceChangeDetail

Defined in Amazonka.CloudFormation.Types.ResourceChangeDetail

Methods

readsPrec :: Int -> ReadS ResourceChangeDetail

readList :: ReadS [ResourceChangeDetail]

readPrec :: ReadPrec ResourceChangeDetail

readListPrec :: ReadPrec [ResourceChangeDetail]

Show ResourceChangeDetail

Defined in Amazonka.CloudFormation.Types.ResourceChangeDetail

Methods

showsPrec :: Int -> ResourceChangeDetail -> ShowS

show :: ResourceChangeDetail -> String

showList :: [ResourceChangeDetail] -> ShowS

NFData ResourceChangeDetail

Defined in Amazonka.CloudFormation.Types.ResourceChangeDetail

Methods

rnf :: ResourceChangeDetail -> ()

Eq ResourceChangeDetail

Defined in Amazonka.CloudFormation.Types.ResourceChangeDetail

Methods

(==) :: ResourceChangeDetail -> ResourceChangeDetail -> Bool

(/=) :: ResourceChangeDetail -> ResourceChangeDetail -> Bool

Hashable ResourceChangeDetail

Defined in Amazonka.CloudFormation.Types.ResourceChangeDetail

Methods

hashWithSalt :: Int -> ResourceChangeDetail -> Int

hash :: ResourceChangeDetail -> Int

type Rep ResourceChangeDetail

Defined in Amazonka.CloudFormation.Types.ResourceChangeDetail

type Rep ResourceChangeDetail = D1 ('MetaData "ResourceChangeDetail" "Amazonka.CloudFormation.Types.ResourceChangeDetail" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ResourceChangeDetail'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "causingEntity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "changeSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangeSource))) :*: (S1 ('MetaSel ('Just "evaluation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationType)) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceTargetDefinition)))))

newResourceChangeDetail :: ResourceChangeDetail

Create a value of ResourceChangeDetail 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:causingEntity:ResourceChangeDetail', resourceChangeDetail_causingEntity - The identity of the entity that triggered this change. This entity is a member of the group that's specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

If the ChangeSource value is DirectModification, no value is given for CausingEntity.

$sel:changeSource:ResourceChangeDetail', resourceChangeDetail_changeSource - The group to which the CausingEntity value belongs. There are five entity groups:

• ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.
• ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.
• ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.
• DirectModification entities are changes that are made directly to the template.
• Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent stack.

$sel:evaluation:ResourceChangeDetail', resourceChangeDetail_evaluation - Indicates whether CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

For Static evaluations, CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

For Dynamic evaluations, can't determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

$sel:target:ResourceChangeDetail', resourceChangeDetail_target - A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.

resourceChangeDetail_causingEntity :: Lens' ResourceChangeDetail (Maybe Text)

The identity of the entity that triggered this change. This entity is a member of the group that's specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

If the ChangeSource value is DirectModification, no value is given for CausingEntity.

resourceChangeDetail_changeSource :: Lens' ResourceChangeDetail (Maybe ChangeSource)

The group to which the CausingEntity value belongs. There are five entity groups:

• ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.
• ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.
• ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.
• DirectModification entities are changes that are made directly to the template.
• Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent stack.

resourceChangeDetail_evaluation :: Lens' ResourceChangeDetail (Maybe EvaluationType)

Indicates whether CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

For Static evaluations, CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

For Dynamic evaluations, can't determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

resourceChangeDetail_target :: Lens' ResourceChangeDetail (Maybe ResourceTargetDefinition)

A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether the resource will be recreated.