blib/lib/Paws/CloudFormation/AccountGateResult.pm untested

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