File Coverage

blib/lib/Paws/CloudFormation/StackSetOperation.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::StackSetOperation;
2 1     1   281 use Moose;
  1         2  
  1         6  
3             has Action => (is => 'ro', isa => 'Str');
4             has CreationTimestamp => (is => 'ro', isa => 'Str');
5             has EndTimestamp => (is => 'ro', isa => 'Str');
6             has OperationId => (is => 'ro', isa => 'Str');
7             has OperationPreferences => (is => 'ro', isa => 'Paws::CloudFormation::StackSetOperationPreferences');
8             has RetainStacks => (is => 'ro', isa => 'Bool');
9             has StackSetId => (is => 'ro', isa => 'Str');
10             has Status => (is => 'ro', isa => 'Str');
11             1;
12              
13             ### main pod documentation begin ###
14              
15             =head1 NAME
16              
17             Paws::CloudFormation::StackSetOperation
18              
19             =head1 USAGE
20              
21             This class represents one of two things:
22              
23             =head3 Arguments in a call to a service
24              
25             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26             Each attribute should be used as a named argument in the calls that expect this type of object.
27              
28             As an example, if Att1 is expected to be a Paws::CloudFormation::StackSetOperation object:
29              
30             $service_obj->Method(Att1 => { Action => $value, ..., Status => $value });
31              
32             =head3 Results returned from an API call
33              
34             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackSetOperation object:
35              
36             $result = $service_obj->Method(...);
37             $result->Att1->Action
38              
39             =head1 DESCRIPTION
40              
41             The structure that contains information about a stack set operation.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 Action => Str
47              
48             The type of stack set operation: C<CREATE>, C<UPDATE>, or C<DELETE>.
49             Create and delete operations affect only the specified stack set
50             instances that are associated with the specified stack set. Update
51             operations affect both the stack set itself, as well as I<all>
52             associated stack set instances.
53              
54              
55             =head2 CreationTimestamp => Str
56              
57             The time at which the operation was initiated. Note that the creation
58             times for the stack set operation might differ from the creation time
59             of the individual stacks themselves. This is because AWS CloudFormation
60             needs to perform preparatory work for the operation, such as
61             dispatching the work to the requested regions, before actually creating
62             the first stacks.
63              
64              
65             =head2 EndTimestamp => Str
66              
67             The time at which the stack set operation ended, across all accounts
68             and regions specified. Note that this doesn't necessarily mean that the
69             stack set operation was successful, or even attempted, in each account
70             or region.
71              
72              
73             =head2 OperationId => Str
74              
75             The unique ID of a stack set operation.
76              
77              
78             =head2 OperationPreferences => L<Paws::CloudFormation::StackSetOperationPreferences>
79              
80             The preferences for how AWS CloudFormation performs this stack set
81             operation.
82              
83              
84             =head2 RetainStacks => Bool
85              
86             For stack set operations of action type C<DELETE>, specifies whether to
87             remove the stack instances from the specified stack set, but doesn't
88             delete the stacks. You can't reassociate a retained stack, or add an
89             existing, saved stack to a new stack set.
90              
91              
92             =head2 StackSetId => Str
93              
94             The ID of the stack set.
95              
96              
97             =head2 Status => Str
98              
99             The status of the operation.
100              
101             =over
102              
103             =item *
104              
105             C<FAILED>: The operation exceeded the specified failure tolerance. The
106             failure tolerance value that you've set for an operation is applied for
107             each region during stack create and update operations. If the number of
108             failed stacks within a region exceeds the failure tolerance, the status
109             of the operation in the region is set to C<FAILED>. This in turn sets
110             the status of the operation as a whole to C<FAILED>, and AWS
111             CloudFormation cancels the operation in any remaining regions.
112              
113             =item *
114              
115             C<RUNNING>: The operation is currently being performed.
116              
117             =item *
118              
119             C<STOPPED>: The user has cancelled the operation.
120              
121             =item *
122              
123             C<STOPPING>: The operation is in the process of stopping, at user
124             request.
125              
126             =item *
127              
128             C<SUCCEEDED>: The operation completed creating or updating all the
129             specified stacks without exceeding the failure tolerance for the
130             operation.
131              
132             =back
133              
134              
135              
136              
137             =head1 SEE ALSO
138              
139             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation>
140              
141             =head1 BUGS and CONTRIBUTIONS
142              
143             The source code is located here: https://github.com/pplu/aws-sdk-perl
144              
145             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
146              
147             =cut
148