File Coverage

blib/lib/Paws/CloudFormation/Stack.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudFormation::Stack;
2 1     1   590 use Moose;
  1     1   5  
  1         9  
  1         402  
  1         2  
  1         6  
3             has Capabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
4             has ChangeSetId => (is => 'ro', isa => 'Str');
5             has CreationTime => (is => 'ro', isa => 'Str', required => 1);
6             has DeletionTime => (is => 'ro', isa => 'Str');
7             has Description => (is => 'ro', isa => 'Str');
8             has DisableRollback => (is => 'ro', isa => 'Bool');
9             has EnableTerminationProtection => (is => 'ro', isa => 'Bool');
10             has LastUpdatedTime => (is => 'ro', isa => 'Str');
11             has NotificationARNs => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
12             has Outputs => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Output]');
13             has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Parameter]');
14             has ParentId => (is => 'ro', isa => 'Str');
15             has RoleARN => (is => 'ro', isa => 'Str');
16             has RollbackConfiguration => (is => 'ro', isa => 'Paws::CloudFormation::RollbackConfiguration');
17             has RootId => (is => 'ro', isa => 'Str');
18             has StackId => (is => 'ro', isa => 'Str');
19             has StackName => (is => 'ro', isa => 'Str', required => 1);
20             has StackStatus => (is => 'ro', isa => 'Str', required => 1);
21             has StackStatusReason => (is => 'ro', isa => 'Str');
22             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Tag]');
23             has TimeoutInMinutes => (is => 'ro', isa => 'Int');
24             1;
25              
26             ### main pod documentation begin ###
27              
28             =head1 NAME
29              
30             Paws::CloudFormation::Stack
31              
32             =head1 USAGE
33              
34             This class represents one of two things:
35              
36             =head3 Arguments in a call to a service
37              
38             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
39             Each attribute should be used as a named argument in the calls that expect this type of object.
40              
41             As an example, if Att1 is expected to be a Paws::CloudFormation::Stack object:
42              
43             $service_obj->Method(Att1 => { Capabilities => $value, ..., TimeoutInMinutes => $value });
44              
45             =head3 Results returned from an API call
46              
47             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::Stack object:
48              
49             $result = $service_obj->Method(...);
50             $result->Att1->Capabilities
51              
52             =head1 DESCRIPTION
53              
54             The Stack data type.
55              
56             =head1 ATTRIBUTES
57              
58              
59             =head2 Capabilities => ArrayRef[Str|Undef]
60              
61             The capabilities allowed in the stack.
62              
63              
64             =head2 ChangeSetId => Str
65              
66             The unique ID of the change set.
67              
68              
69             =head2 B<REQUIRED> CreationTime => Str
70              
71             The time at which the stack was created.
72              
73              
74             =head2 DeletionTime => Str
75              
76             The time the stack was deleted.
77              
78              
79             =head2 Description => Str
80              
81             A user-defined description associated with the stack.
82              
83              
84             =head2 DisableRollback => Bool
85              
86             Boolean to enable or disable rollback on stack creation failures:
87              
88             =over
89              
90             =item *
91              
92             C<true>: disable rollback
93              
94             =item *
95              
96             C<false>: enable rollback
97              
98             =back
99              
100              
101              
102             =head2 EnableTerminationProtection => Bool
103              
104             Whether termination protection is enabled for the stack.
105              
106             For nested stacks, termination protection is set on the root stack and
107             cannot be changed directly on the nested stack. For more information,
108             see Protecting a Stack From Being Deleted in the I<AWS CloudFormation
109             User Guide>.
110              
111              
112             =head2 LastUpdatedTime => Str
113              
114             The time the stack was last updated. This field will only be returned
115             if the stack has been updated at least once.
116              
117              
118             =head2 NotificationARNs => ArrayRef[Str|Undef]
119              
120             SNS topic ARNs to which stack related events are published.
121              
122              
123             =head2 Outputs => ArrayRef[L<Paws::CloudFormation::Output>]
124              
125             A list of output structures.
126              
127              
128             =head2 Parameters => ArrayRef[L<Paws::CloudFormation::Parameter>]
129              
130             A list of C<Parameter> structures.
131              
132              
133             =head2 ParentId => Str
134              
135             For nested stacks--stacks created as resources for another stack--the
136             stack ID of the direct parent of this stack. For the first level of
137             nested stacks, the root stack is also the parent stack.
138              
139             For more information, see Working with Nested Stacks in the I<AWS
140             CloudFormation User Guide>.
141              
142              
143             =head2 RoleARN => Str
144              
145             The Amazon Resource Name (ARN) of an AWS Identity and Access Management
146             (IAM) role that is associated with the stack. During a stack operation,
147             AWS CloudFormation uses this role's credentials to make calls on your
148             behalf.
149              
150              
151             =head2 RollbackConfiguration => L<Paws::CloudFormation::RollbackConfiguration>
152              
153             The rollback triggers for AWS CloudFormation to monitor during stack
154             creation and updating operations, and for the specified monitoring
155             period afterwards.
156              
157              
158             =head2 RootId => Str
159              
160             For nested stacks--stacks created as resources for another stack--the
161             stack ID of the the top-level stack to which the nested stack
162             ultimately belongs.
163              
164             For more information, see Working with Nested Stacks in the I<AWS
165             CloudFormation User Guide>.
166              
167              
168             =head2 StackId => Str
169              
170             Unique identifier of the stack.
171              
172              
173             =head2 B<REQUIRED> StackName => Str
174              
175             The name associated with the stack.
176              
177              
178             =head2 B<REQUIRED> StackStatus => Str
179              
180             Current status of the stack.
181              
182              
183             =head2 StackStatusReason => Str
184              
185             Success/failure message associated with the stack status.
186              
187              
188             =head2 Tags => ArrayRef[L<Paws::CloudFormation::Tag>]
189              
190             A list of C<Tag>s that specify information about the stack.
191              
192              
193             =head2 TimeoutInMinutes => Int
194              
195             The amount of time within which stack creation should complete.
196              
197              
198              
199             =head1 SEE ALSO
200              
201             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation>
202              
203             =head1 BUGS and CONTRIBUTIONS
204              
205             The source code is located here: https://github.com/pplu/aws-sdk-perl
206              
207             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
208              
209             =cut
210