Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

JROBINSON / Paws-0.46 / lib / Paws / CloudFormation / StackSetOperationSummary.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
—
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

              
# Generated by default/object.tt
package Paws::CloudFormation::StackSetOperationSummary;
  use Moose;
  has Action => (is => 'ro', isa => 'Str');
  has CreationTimestamp => (is => 'ro', isa => 'Str');
  has EndTimestamp => (is => 'ro', isa => 'Str');
  has OperationId => (is => 'ro', isa => 'Str');
  has Status => (is => 'ro', isa => 'Str');
1;
### main pod documentation begin ###
=head1 NAME
Paws::CloudFormation::StackSetOperationSummary
=head1 USAGE
This class represents one of two things:
=head3 Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. 
Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::CloudFormation::StackSetOperationSummary object:
  $service_obj->Method(Att1 => { Action => $value, ..., Status => $value  });
=head3 Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackSetOperationSummary object:
  $result = $service_obj->Method(...);
  $result->Att1->Action
=head1 DESCRIPTION
The structures that contain summary information about the specified
operation.
=head1 ATTRIBUTES
=head2 Action => Str
The type of operation: C<CREATE>, C<UPDATE>, or C<DELETE>. Create and
delete operations affect only the specified stack instances that are
associated with the specified stack set. Update operations affect both
the stack set itself as well as I<all> associated stack set instances.
=head2 CreationTimestamp => Str
The time at which the operation was initiated. Note that the creation
times for the stack set operation might differ from the creation time
of the individual stacks themselves. This is because AWS CloudFormation
needs to perform preparatory work for the operation, such as
dispatching the work to the requested Regions, before actually creating
the first stacks.
=head2 EndTimestamp => Str
The time at which the stack set operation ended, across all accounts
and Regions specified. Note that this doesn't necessarily mean that the
stack set operation was successful, or even attempted, in each account
or Region.
=head2 OperationId => Str
The unique ID of the stack set operation.
=head2 Status => Str
The overall status of the operation.
=over
=item *
C<FAILED>: The operation exceeded the specified failure tolerance. The
failure tolerance value that you've set for an operation is applied for
each Region during stack create and update operations. If the number of
failed stacks within a Region exceeds the failure tolerance, the status
of the operation in the Region is set to C<FAILED>. This in turn sets
the status of the operation as a whole to C<FAILED>, and AWS
CloudFormation cancels the operation in any remaining Regions.
=item *
C<QUEUED>: [Service-managed permissions] For automatic deployments that
require a sequence of operations, the operation is queued to be
performed. For more information, see the stack set operation status
codes
(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes)
in the AWS CloudFormation User Guide.
=item *
C<RUNNING>: The operation is currently being performed.
=item *
C<STOPPED>: The user has cancelled the operation.
=item *
C<STOPPING>: The operation is in the process of stopping, at user
request.
=item *
C<SUCCEEDED>: The operation completed creating or updating all the
specified stacks without exceeding the failure tolerance for the
operation.
=back
=head1 SEE ALSO
This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation>
=head1 BUGS and CONTRIBUTIONS
The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
=cut