« blib/lib/Paws/CloudFormation/ResourceChange.pm
↑ Summary
blib/lib/Paws/CloudFormation/ResourceIdentifierProperties.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::ResourceChangeDetail; | ||
| 3 | use Moose; | ||
| 4 | has CausingEntity => (is => 'ro', isa => 'Str'); | ||
| 5 | has ChangeSource => (is => 'ro', isa => 'Str'); | ||
| 6 | has Evaluation => (is => 'ro', isa => 'Str'); | ||
| 7 | has Target => (is => 'ro', isa => 'Paws::CloudFormation::ResourceTargetDefinition'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::CloudFormation::ResourceChangeDetail | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::CloudFormation::ResourceChangeDetail object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { CausingEntity => $value, ..., Target => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::ResourceChangeDetail object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->CausingEntity | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | For a resource with C<Modify> as the action, the C<ResourceChange> | ||
| 40 | structure describes the changes AWS CloudFormation will make to that | ||
| 41 | resource. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 CausingEntity => Str | ||
| 47 | |||
| 48 | The identity of the entity that triggered this change. This entity is a | ||
| 49 | member of the group that is specified by the C<ChangeSource> field. For | ||
| 50 | example, if you modified the value of the C<KeyPairName> parameter, the | ||
| 51 | C<CausingEntity> is the name of the parameter (C<KeyPairName>). | ||
| 52 | |||
| 53 | If the C<ChangeSource> value is C<DirectModification>, no value is | ||
| 54 | given for C<CausingEntity>. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ChangeSource => Str | ||
| 58 | |||
| 59 | The group to which the C<CausingEntity> value belongs. There are five | ||
| 60 | entity groups: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<ResourceReference> entities are C<Ref> intrinsic functions that refer | ||
| 67 | to resources in the template, such as C<{ "Ref" : | ||
| 68 | "MyEC2InstanceResource" }>. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<ParameterReference> entities are C<Ref> intrinsic functions that get | ||
| 73 | template parameter values, such as C<{ "Ref" : "MyPasswordParameter" | ||
| 74 | }>. | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<ResourceAttribute> entities are C<Fn::GetAtt> intrinsic functions | ||
| 79 | that get resource attribute values, such as C<{ "Fn::GetAtt" : [ | ||
| 80 | "MyEC2InstanceResource", "PublicDnsName" ] }>. | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<DirectModification> entities are changes that are made directly to | ||
| 85 | the template. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<Automatic> entities are C<AWS::CloudFormation::Stack> resource types, | ||
| 90 | which are also known as nested stacks. If you made no changes to the | ||
| 91 | C<AWS::CloudFormation::Stack> resource, AWS CloudFormation sets the | ||
| 92 | C<ChangeSource> to C<Automatic> because the nested stack's template | ||
| 93 | might have changed. Changes to a nested stack's template aren't visible | ||
| 94 | to AWS CloudFormation until you run an update on the parent stack. | ||
| 95 | |||
| 96 | =back | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 Evaluation => Str | ||
| 101 | |||
| 102 | Indicates whether AWS CloudFormation can determine the target value, | ||
| 103 | and whether the target value will change before you execute a change | ||
| 104 | set. | ||
| 105 | |||
| 106 | For C<Static> evaluations, AWS CloudFormation can determine that the | ||
| 107 | target value will change, and its value. For example, if you directly | ||
| 108 | modify the C<InstanceType> property of an EC2 instance, AWS | ||
| 109 | CloudFormation knows that this property value will change, and its | ||
| 110 | value, so this is a C<Static> evaluation. | ||
| 111 | |||
| 112 | For C<Dynamic> evaluations, cannot determine the target value because | ||
| 113 | it depends on the result of an intrinsic function, such as a C<Ref> or | ||
| 114 | C<Fn::GetAtt> intrinsic function, when the stack is updated. For | ||
| 115 | example, if your template includes a reference to a resource that is | ||
| 116 | conditionally recreated, the value of the reference (the physical ID of | ||
| 117 | the resource) might change, depending on if the resource is recreated. | ||
| 118 | If the resource is recreated, it will have a new physical ID, so all | ||
| 119 | references to that resource will also be updated. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 Target => L<Paws::CloudFormation::ResourceTargetDefinition> | ||
| 123 | |||
| 124 | A C<ResourceTargetDefinition> structure that describes the field that | ||
| 125 | AWS CloudFormation will change and whether the resource will be | ||
| 126 | recreated. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |