File Coverage

blib/lib/Paws/CloudFormation/StackSetOperationResultSummary.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::StackSetOperationResultSummary;
2 1     1   342 use Moose;
  1         3  
  1         6  
3             has Account => (is => 'ro', isa => 'Str');
4             has AccountGateResult => (is => 'ro', isa => 'Paws::CloudFormation::AccountGateResult');
5             has Region => (is => 'ro', isa => 'Str');
6             has Status => (is => 'ro', isa => 'Str');
7             has StatusReason => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::CloudFormation::StackSetOperationResultSummary
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::StackSetOperationResultSummary object:
26              
27             $service_obj->Method(Att1 => { Account => $value, ..., StatusReason => $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::StackSetOperationResultSummary object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Account
35              
36             =head1 DESCRIPTION
37              
38             The structure that contains information about a specified operation's
39             results for a given account in a given region.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 Account => Str
45              
46             The name of the AWS account for this operation result.
47              
48              
49             =head2 AccountGateResult => L<Paws::CloudFormation::AccountGateResult>
50              
51             The results of the account gate function AWS CloudFormation invokes, if
52             present, before proceeding with stack set operations in an account
53              
54              
55             =head2 Region => Str
56              
57             The name of the AWS region for this operation result.
58              
59              
60             =head2 Status => Str
61              
62             The result status of the stack set operation for the given account in
63             the given region.
64              
65             =over
66              
67             =item *
68              
69             C<CANCELLED>: The operation in the specified account and region has
70             been cancelled. This is either because a user has stopped the stack set
71             operation, or because the failure tolerance of the stack set operation
72             has been exceeded.
73              
74             =item *
75              
76             C<FAILED>: The operation in the specified account and region failed.
77              
78             If the stack set operation fails in enough accounts within a region,
79             the failure tolerance for the stack set operation as a whole might be
80             exceeded.
81              
82             =item *
83              
84             C<RUNNING>: The operation in the specified account and region is
85             currently in progress.
86              
87             =item *
88              
89             C<PENDING>: The operation in the specified account and region has yet
90             to start.
91              
92             =item *
93              
94             C<SUCCEEDED>: The operation in the specified account and region
95             completed successfully.
96              
97             =back
98              
99              
100              
101             =head2 StatusReason => Str
102              
103             The reason for the assigned result status.
104              
105              
106              
107             =head1 SEE ALSO
108              
109             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation>
110              
111             =head1 BUGS and CONTRIBUTIONS
112              
113             The source code is located here: https://github.com/pplu/aws-sdk-perl
114              
115             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
116              
117             =cut
118