line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
package Paws::CloudFormation::AccountGateResult; |
2
|
1
|
|
|
1
|
|
348
|
use Moose; |
|
1
|
|
|
|
|
3
|
|
|
1
|
|
|
|
|
7
|
|
3
|
|
|
|
|
|
|
has Status => (is => 'ro', isa => 'Str'); |
4
|
|
|
|
|
|
|
has StatusReason => (is => 'ro', isa => 'Str'); |
5
|
|
|
|
|
|
|
1; |
6
|
|
|
|
|
|
|
|
7
|
|
|
|
|
|
|
### main pod documentation begin ### |
8
|
|
|
|
|
|
|
|
9
|
|
|
|
|
|
|
=head1 NAME |
10
|
|
|
|
|
|
|
|
11
|
|
|
|
|
|
|
Paws::CloudFormation::AccountGateResult |
12
|
|
|
|
|
|
|
|
13
|
|
|
|
|
|
|
=head1 USAGE |
14
|
|
|
|
|
|
|
|
15
|
|
|
|
|
|
|
This class represents one of two things: |
16
|
|
|
|
|
|
|
|
17
|
|
|
|
|
|
|
=head3 Arguments in a call to a service |
18
|
|
|
|
|
|
|
|
19
|
|
|
|
|
|
|
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. |
20
|
|
|
|
|
|
|
Each attribute should be used as a named argument in the calls that expect this type of object. |
21
|
|
|
|
|
|
|
|
22
|
|
|
|
|
|
|
As an example, if Att1 is expected to be a Paws::CloudFormation::AccountGateResult object: |
23
|
|
|
|
|
|
|
|
24
|
|
|
|
|
|
|
$service_obj->Method(Att1 => { Status => $value, ..., StatusReason => $value }); |
25
|
|
|
|
|
|
|
|
26
|
|
|
|
|
|
|
=head3 Results returned from an API call |
27
|
|
|
|
|
|
|
|
28
|
|
|
|
|
|
|
Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::AccountGateResult object: |
29
|
|
|
|
|
|
|
|
30
|
|
|
|
|
|
|
$result = $service_obj->Method(...); |
31
|
|
|
|
|
|
|
$result->Att1->Status |
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
=head1 DESCRIPTION |
34
|
|
|
|
|
|
|
|
35
|
|
|
|
|
|
|
Structure that contains the results of the account gate function which |
36
|
|
|
|
|
|
|
AWS CloudFormation invokes, if present, before proceeding with a stack |
37
|
|
|
|
|
|
|
set operation in an account and region. |
38
|
|
|
|
|
|
|
|
39
|
|
|
|
|
|
|
For each account and region, AWS CloudFormation lets you specify a |
40
|
|
|
|
|
|
|
Lamdba function that encapsulates any requirements that must be met |
41
|
|
|
|
|
|
|
before CloudFormation can proceed with a stack set operation in that |
42
|
|
|
|
|
|
|
account and region. CloudFormation invokes the function each time a |
43
|
|
|
|
|
|
|
stack set operation is requested for that account and region; if the |
44
|
|
|
|
|
|
|
function returns C<FAILED>, CloudFormation cancels the operation in |
45
|
|
|
|
|
|
|
that account and region, and sets the stack set operation result status |
46
|
|
|
|
|
|
|
for that account and region to C<FAILED>. |
47
|
|
|
|
|
|
|
|
48
|
|
|
|
|
|
|
For more information, see Configuring a target account gate. |
49
|
|
|
|
|
|
|
|
50
|
|
|
|
|
|
|
=head1 ATTRIBUTES |
51
|
|
|
|
|
|
|
|
52
|
|
|
|
|
|
|
|
53
|
|
|
|
|
|
|
=head2 Status => Str |
54
|
|
|
|
|
|
|
|
55
|
|
|
|
|
|
|
The status of the account gate function. |
56
|
|
|
|
|
|
|
|
57
|
|
|
|
|
|
|
=over |
58
|
|
|
|
|
|
|
|
59
|
|
|
|
|
|
|
=item * |
60
|
|
|
|
|
|
|
|
61
|
|
|
|
|
|
|
C<SUCCEEDED>: The account gate function has determined that the account |
62
|
|
|
|
|
|
|
and region passes any requirements for a stack set operation to occur. |
63
|
|
|
|
|
|
|
AWS CloudFormation proceeds with the stack operation in that account |
64
|
|
|
|
|
|
|
and region. |
65
|
|
|
|
|
|
|
|
66
|
|
|
|
|
|
|
=item * |
67
|
|
|
|
|
|
|
|
68
|
|
|
|
|
|
|
C<FAILED>: The account gate function has determined that the account |
69
|
|
|
|
|
|
|
and region does not meet the requirements for a stack set operation to |
70
|
|
|
|
|
|
|
occur. AWS CloudFormation cancels the stack set operation in that |
71
|
|
|
|
|
|
|
account and region, and sets the stack set operation result status for |
72
|
|
|
|
|
|
|
that account and region to C<FAILED>. |
73
|
|
|
|
|
|
|
|
74
|
|
|
|
|
|
|
=item * |
75
|
|
|
|
|
|
|
|
76
|
|
|
|
|
|
|
C<SKIPPED>: AWS CloudFormation has skipped calling the account gate |
77
|
|
|
|
|
|
|
function for this account and region, for one of the following reasons: |
78
|
|
|
|
|
|
|
|
79
|
|
|
|
|
|
|
=over |
80
|
|
|
|
|
|
|
|
81
|
|
|
|
|
|
|
=item * |
82
|
|
|
|
|
|
|
|
83
|
|
|
|
|
|
|
An account gate function has not been specified for the account and |
84
|
|
|
|
|
|
|
region. AWS CloudFormation proceeds with the stack set operation in |
85
|
|
|
|
|
|
|
this account and region. |
86
|
|
|
|
|
|
|
|
87
|
|
|
|
|
|
|
=item * |
88
|
|
|
|
|
|
|
|
89
|
|
|
|
|
|
|
The C<AWSCloudFormationStackSetExecutionRole> of the stack set |
90
|
|
|
|
|
|
|
adminstration account lacks permissions to invoke the function. AWS |
91
|
|
|
|
|
|
|
CloudFormation proceeds with the stack set operation in this account |
92
|
|
|
|
|
|
|
and region. |
93
|
|
|
|
|
|
|
|
94
|
|
|
|
|
|
|
=item * |
95
|
|
|
|
|
|
|
|
96
|
|
|
|
|
|
|
Either no action is necessary, or no action is possible, on the stack. |
97
|
|
|
|
|
|
|
AWS CloudFormation skips the stack set operation in this account and |
98
|
|
|
|
|
|
|
region. |
99
|
|
|
|
|
|
|
|
100
|
|
|
|
|
|
|
=back |
101
|
|
|
|
|
|
|
|
102
|
|
|
|
|
|
|
=back |
103
|
|
|
|
|
|
|
|
104
|
|
|
|
|
|
|
|
105
|
|
|
|
|
|
|
|
106
|
|
|
|
|
|
|
=head2 StatusReason => Str |
107
|
|
|
|
|
|
|
|
108
|
|
|
|
|
|
|
The reason for the account gate status assigned to this account and |
109
|
|
|
|
|
|
|
region for the stack set operation. |
110
|
|
|
|
|
|
|
|
111
|
|
|
|
|
|
|
|
112
|
|
|
|
|
|
|
|
113
|
|
|
|
|
|
|
=head1 SEE ALSO |
114
|
|
|
|
|
|
|
|
115
|
|
|
|
|
|
|
This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> |
116
|
|
|
|
|
|
|
|
117
|
|
|
|
|
|
|
=head1 BUGS and CONTRIBUTIONS |
118
|
|
|
|
|
|
|
|
119
|
|
|
|
|
|
|
The source code is located here: https://github.com/pplu/aws-sdk-perl |
120
|
|
|
|
|
|
|
|
121
|
|
|
|
|
|
|
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues |
122
|
|
|
|
|
|
|
|
123
|
|
|
|
|
|
|
=cut |
124
|
|
|
|
|
|
|
|