File Coverage

blib/lib/Paws/CloudFormation/StackInstance.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::StackInstance;
2 1     1   288 use Moose;
  1         3  
  1         5  
3             has Account => (is => 'ro', isa => 'Str');
4             has Region => (is => 'ro', isa => 'Str');
5             has StackId => (is => 'ro', isa => 'Str');
6             has StackSetId => (is => 'ro', isa => 'Str');
7             has Status => (is => 'ro', isa => 'Str');
8             has StatusReason => (is => 'ro', isa => 'Str');
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::CloudFormation::StackInstance
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::CloudFormation::StackInstance object:
27              
28             $service_obj->Method(Att1 => { Account => $value, ..., StatusReason => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackInstance object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->Account
36              
37             =head1 DESCRIPTION
38              
39             An AWS CloudFormation stack, in a specific account and region, that's
40             part of a stack set operation. A stack instance is a reference to an
41             attempted or actual stack in a given account within a given region. A
42             stack instance can exist without a stackE<mdash>for example, if the
43             stack couldn't be created for some reason. A stack instance is
44             associated with only one stack set. Each stack instance contains the ID
45             of its associated stack set, as well as the ID of the actual stack and
46             the stack status.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 Account => Str
52              
53             The name of the AWS account that the stack instance is associated with.
54              
55              
56             =head2 Region => Str
57              
58             The name of the AWS region that the stack instance is associated with.
59              
60              
61             =head2 StackId => Str
62              
63             The ID of the stack instance.
64              
65              
66             =head2 StackSetId => Str
67              
68             The name or unique ID of the stack set that the stack instance is
69             associated with.
70              
71              
72             =head2 Status => Str
73              
74             The status of the stack instance, in terms of its synchronization with
75             its associated stack set.
76              
77             =over
78              
79             =item *
80              
81             C<INOPERABLE>: A C<DeleteStackInstances> operation has failed and left
82             the stack in an unstable state. Stacks in this state are excluded from
83             further C<UpdateStackSet> operations. You might need to perform a
84             C<DeleteStackInstances> operation, with C<RetainStacks> set to C<true>,
85             to delete the stack instance, and then delete the stack manually.
86              
87             =item *
88              
89             C<OUTDATED>: The stack isn't currently up to date with the stack set
90             because:
91              
92             =over
93              
94             =item *
95              
96             The associated stack failed during a C<CreateStackSet> or
97             C<UpdateStackSet> operation.
98              
99             =item *
100              
101             The stack was part of a C<CreateStackSet> or C<UpdateStackSet>
102             operation that failed or was stopped before the stack was created or
103             updated.
104              
105             =back
106              
107             =item *
108              
109             C<CURRENT>: The stack is currently up to date with the stack set.
110              
111             =back
112              
113              
114              
115             =head2 StatusReason => Str
116              
117             The explanation for the specific status code that is assigned to this
118             stack instance.
119              
120              
121              
122             =head1 SEE ALSO
123              
124             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation>
125              
126             =head1 BUGS and CONTRIBUTIONS
127              
128             The source code is located here: https://github.com/pplu/aws-sdk-perl
129              
130             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
131              
132             =cut
133