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