File Coverage

blib/lib/Paws/CloudFormation/ResourceChange.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::ResourceChange;
2 1     1   711 use Moose;
  1         4  
  1         10  
3             has Action => (is => 'ro', isa => 'Str');
4             has Details => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::ResourceChangeDetail]');
5             has LogicalResourceId => (is => 'ro', isa => 'Str');
6             has PhysicalResourceId => (is => 'ro', isa => 'Str');
7             has Replacement => (is => 'ro', isa => 'Str');
8             has ResourceType => (is => 'ro', isa => 'Str');
9             has Scope => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::CloudFormation::ResourceChange
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::CloudFormation::ResourceChange object:
28              
29             $service_obj->Method(Att1 => { Action => $value, ..., Scope => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::ResourceChange object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->Action
37              
38             =head1 DESCRIPTION
39              
40             The C<ResourceChange> structure describes the resource and the action
41             that AWS CloudFormation will perform on it if you execute this change
42             set.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 Action => Str
48              
49             The action that AWS CloudFormation takes on the resource, such as
50             C<Add> (adds a new resource), C<Modify> (changes a resource), or
51             C<Remove> (deletes a resource).
52              
53              
54             =head2 Details => ArrayRef[L<Paws::CloudFormation::ResourceChangeDetail>]
55              
56             For the C<Modify> action, a list of C<ResourceChangeDetail> structures
57             that describes the changes that AWS CloudFormation will make to the
58             resource.
59              
60              
61             =head2 LogicalResourceId => Str
62              
63             The resource's logical ID, which is defined in the stack's template.
64              
65              
66             =head2 PhysicalResourceId => Str
67              
68             The resource's physical ID (resource name). Resources that you are
69             adding don't have physical IDs because they haven't been created.
70              
71              
72             =head2 Replacement => Str
73              
74             For the C<Modify> action, indicates whether AWS CloudFormation will
75             replace the resource by creating a new one and deleting the old one.
76             This value depends on the value of the C<RequiresRecreation> property
77             in the C<ResourceTargetDefinition> structure. For example, if the
78             C<RequiresRecreation> field is C<Always> and the C<Evaluation> field is
79             C<Static>, C<Replacement> is C<True>. If the C<RequiresRecreation>
80             field is C<Always> and the C<Evaluation> field is C<Dynamic>,
81             C<Replacement> is C<Conditionally>.
82              
83             If you have multiple changes with different C<RequiresRecreation>
84             values, the C<Replacement> value depends on the change with the most
85             impact. A C<RequiresRecreation> value of C<Always> has the most impact,
86             followed by C<Conditionally>, and then C<Never>.
87              
88              
89             =head2 ResourceType => Str
90              
91             The type of AWS CloudFormation resource, such as C<AWS::S3::Bucket>.
92              
93              
94             =head2 Scope => ArrayRef[Str|Undef]
95              
96             For the C<Modify> action, indicates which resource attribute is
97             triggering this update, such as a change in the resource attribute's
98             C<Metadata>, C<Properties>, or C<Tags>.
99              
100              
101              
102             =head1 SEE ALSO
103              
104             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation>
105              
106             =head1 BUGS and CONTRIBUTIONS
107              
108             The source code is located here: https://github.com/pplu/aws-sdk-perl
109              
110             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
111              
112             =cut
113