File Coverage

blib/lib/Paws/CloudFormation/ResourceChangeDetail.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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