« blib/lib/Paws/CloudFormation/StackEvent.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackInstanceComprehensiveStatus.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackInstance; | ||
| 3 | use Moose; | ||
| 4 | has Account => (is => 'ro', isa => 'Str'); | ||
| 5 | has DriftStatus => (is => 'ro', isa => 'Str'); | ||
| 6 | has LastDriftCheckTimestamp => (is => 'ro', isa => 'Str'); | ||
| 7 | has OrganizationalUnitId => (is => 'ro', isa => 'Str'); | ||
| 8 | has ParameterOverrides => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Parameter]'); | ||
| 9 | has Region => (is => 'ro', isa => 'Str'); | ||
| 10 | has StackId => (is => 'ro', isa => 'Str'); | ||
| 11 | has StackInstanceStatus => (is => 'ro', isa => 'Paws::CloudFormation::StackInstanceComprehensiveStatus'); | ||
| 12 | has StackSetId => (is => 'ro', isa => 'Str'); | ||
| 13 | has Status => (is => 'ro', isa => 'Str'); | ||
| 14 | has StatusReason => (is => 'ro', isa => 'Str'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudFormation::StackInstance | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::CloudFormation::StackInstance object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { Account => $value, ..., StatusReason => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackInstance object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->Account | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | An AWS CloudFormation stack, in a specific account and Region, that's | ||
| 47 | part of a stack set operation. A stack instance is a reference to an | ||
| 48 | attempted or actual stack in a given account within a given Region. A | ||
| 49 | stack instance can exist without a stackE<mdash>for example, if the | ||
| 50 | stack couldn't be created for some reason. A stack instance is | ||
| 51 | associated with only one stack set. Each stack instance contains the ID | ||
| 52 | of its associated stack set, as well as the ID of the actual stack and | ||
| 53 | the stack status. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Account => Str | ||
| 59 | |||
| 60 | [Self-managed permissions] The name of the AWS account that the stack | ||
| 61 | instance is associated with. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 DriftStatus => Str | ||
| 65 | |||
| 66 | Status of the stack instance's actual configuration compared to the | ||
| 67 | expected template and parameter configuration of the stack set to which | ||
| 68 | it belongs. | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<DRIFTED>: The stack differs from the expected template and parameter | ||
| 75 | configuration of the stack set to which it belongs. A stack instance is | ||
| 76 | considered to have drifted if one or more of the resources in the | ||
| 77 | associated stack have drifted. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<NOT_CHECKED>: AWS CloudFormation has not checked if the stack | ||
| 82 | instance differs from its expected stack set configuration. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<IN_SYNC>: The stack instance's actual configuration matches its | ||
| 87 | expected stack set configuration. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<UNKNOWN>: This value is reserved for future use. | ||
| 92 | |||
| 93 | =back | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 LastDriftCheckTimestamp => Str | ||
| 98 | |||
| 99 | Most recent time when CloudFormation performed a drift detection | ||
| 100 | operation on the stack instance. This value will be C<NULL> for any | ||
| 101 | stack instance on which drift detection has not yet been performed. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 OrganizationalUnitId => Str | ||
| 105 | |||
| 106 | [Service-managed permissions] The organization root ID or | ||
| 107 | organizational unit (OU) IDs that you specified for DeploymentTargets | ||
| 108 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html). | ||
| 109 | |||
| 110 | |||
| 111 | =head2 ParameterOverrides => ArrayRef[L<Paws::CloudFormation::Parameter>] | ||
| 112 | |||
| 113 | A list of parameters from the stack set template whose values have been | ||
| 114 | overridden in this stack instance. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 Region => Str | ||
| 118 | |||
| 119 | The name of the AWS Region that the stack instance is associated with. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 StackId => Str | ||
| 123 | |||
| 124 | The ID of the stack instance. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 StackInstanceStatus => L<Paws::CloudFormation::StackInstanceComprehensiveStatus> | ||
| 128 | |||
| 129 | The detailed status of the stack instance. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 StackSetId => Str | ||
| 133 | |||
| 134 | The name or unique ID of the stack set that the stack instance is | ||
| 135 | associated with. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 Status => Str | ||
| 139 | |||
| 140 | The status of the stack instance, in terms of its synchronization with | ||
| 141 | its associated stack set. | ||
| 142 | |||
| 143 | =over | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | C<INOPERABLE>: A C<DeleteStackInstances> operation has failed and left | ||
| 148 | the stack in an unstable state. Stacks in this state are excluded from | ||
| 149 | further C<UpdateStackSet> operations. You might need to perform a | ||
| 150 | C<DeleteStackInstances> operation, with C<RetainStacks> set to C<true>, | ||
| 151 | to delete the stack instance, and then delete the stack manually. | ||
| 152 | |||
| 153 | =item * | ||
| 154 | |||
| 155 | C<OUTDATED>: The stack isn't currently up to date with the stack set | ||
| 156 | because: | ||
| 157 | |||
| 158 | =over | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | The associated stack failed during a C<CreateStackSet> or | ||
| 163 | C<UpdateStackSet> operation. | ||
| 164 | |||
| 165 | =item * | ||
| 166 | |||
| 167 | The stack was part of a C<CreateStackSet> or C<UpdateStackSet> | ||
| 168 | operation that failed or was stopped before the stack was created or | ||
| 169 | updated. | ||
| 170 | |||
| 171 | =back | ||
| 172 | |||
| 173 | =item * | ||
| 174 | |||
| 175 | C<CURRENT>: The stack is currently up to date with the stack set. | ||
| 176 | |||
| 177 | =back | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 StatusReason => Str | ||
| 182 | |||
| 183 | The explanation for the specific status code that is assigned to this | ||
| 184 | stack instance. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head1 SEE ALSO | ||
| 189 | |||
| 190 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 191 | |||
| 192 | =head1 BUGS and CONTRIBUTIONS | ||
| 193 | |||
| 194 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 195 | |||
| 196 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 197 | |||
| 198 | =cut | ||
| 199 |