File Coverage

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