« blib/lib/Paws/CloudFormation/StackSet.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackSetOperation.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackSetDriftDetectionDetails; | ||
| 3 | use Moose; | ||
| 4 | has DriftDetectionStatus => (is => 'ro', isa => 'Str'); | ||
| 5 | has DriftedStackInstancesCount => (is => 'ro', isa => 'Int'); | ||
| 6 | has DriftStatus => (is => 'ro', isa => 'Str'); | ||
| 7 | has FailedStackInstancesCount => (is => 'ro', isa => 'Int'); | ||
| 8 | has InProgressStackInstancesCount => (is => 'ro', isa => 'Int'); | ||
| 9 | has InSyncStackInstancesCount => (is => 'ro', isa => 'Int'); | ||
| 10 | has LastDriftCheckTimestamp => (is => 'ro', isa => 'Str'); | ||
| 11 | has TotalStackInstancesCount => (is => 'ro', isa => 'Int'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CloudFormation::StackSetDriftDetectionDetails | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::CloudFormation::StackSetDriftDetectionDetails object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { DriftDetectionStatus => $value, ..., TotalStackInstancesCount => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFormation::StackSetDriftDetectionDetails object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->DriftDetectionStatus | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Detailed information about the drift status of the stack set. | ||
| 44 | |||
| 45 | For stack sets, contains information about the last I<completed> drift | ||
| 46 | operation performed on the stack set. Information about drift | ||
| 47 | operations in-progress is not included. | ||
| 48 | |||
| 49 | For stack set operations, includes information about drift operations | ||
| 50 | currently being performed on the stack set. | ||
| 51 | |||
| 52 | For more information, see Detecting Unmanaged Changes in Stack Sets | ||
| 53 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html) | ||
| 54 | in the I<AWS CloudFormation User Guide>. | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 DriftDetectionStatus => Str | ||
| 60 | |||
| 61 | The status of the stack set drift detection operation. | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | C<COMPLETED>: The drift detection operation completed without failing | ||
| 68 | on any stack instances. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<FAILED>: The drift detection operation exceeded the specified failure | ||
| 73 | tolerance. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<PARTIAL_SUCCESS>: The drift detection operation completed without | ||
| 78 | exceeding the failure tolerance for the operation. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<IN_PROGRESS>: The drift detection operation is currently being | ||
| 83 | performed. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<STOPPED>: The user has cancelled the drift detection operation. | ||
| 88 | |||
| 89 | =back | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 DriftedStackInstancesCount => Int | ||
| 94 | |||
| 95 | The number of stack instances that have drifted from the expected | ||
| 96 | template and parameter configuration of the stack set. A stack instance | ||
| 97 | is considered to have drifted if one or more of the resources in the | ||
| 98 | associated stack do not match their expected configuration. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 DriftStatus => Str | ||
| 102 | |||
| 103 | Status of the stack set's actual configuration compared to its expected | ||
| 104 | template and parameter configuration. A stack set is considered to have | ||
| 105 | drifted if one or more of its stack instances have drifted from their | ||
| 106 | expected template and parameter configuration. | ||
| 107 | |||
| 108 | =over | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<DRIFTED>: One or more of the stack instances belonging to the stack | ||
| 113 | set stack differs from the expected template and parameter | ||
| 114 | configuration. A stack instance is considered to have drifted if one or | ||
| 115 | more of the resources in the associated stack have drifted. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<NOT_CHECKED>: AWS CloudFormation has not checked the stack set for | ||
| 120 | drift. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | C<IN_SYNC>: All of the stack instances belonging to the stack set stack | ||
| 125 | match from the expected template and parameter configuration. | ||
| 126 | |||
| 127 | =back | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 FailedStackInstancesCount => Int | ||
| 132 | |||
| 133 | The number of stack instances for which the drift detection operation | ||
| 134 | failed. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 InProgressStackInstancesCount => Int | ||
| 138 | |||
| 139 | The number of stack instances that are currently being checked for | ||
| 140 | drift. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 InSyncStackInstancesCount => Int | ||
| 144 | |||
| 145 | The number of stack instances which match the expected template and | ||
| 146 | parameter configuration of the stack set. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 LastDriftCheckTimestamp => Str | ||
| 150 | |||
| 151 | Most recent time when CloudFormation performed a drift detection | ||
| 152 | operation on the stack set. This value will be C<NULL> for any stack | ||
| 153 | set on which drift detection has not yet been performed. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 TotalStackInstancesCount => Int | ||
| 157 | |||
| 158 | The total number of stack instances belonging to this stack set. | ||
| 159 | |||
| 160 | The total number of stack instances is equal to the total of: | ||
| 161 | |||
| 162 | =over | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | Stack instances that match the stack set configuration. | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | Stack instances that have drifted from the stack set configuration. | ||
| 171 | |||
| 172 | =item * | ||
| 173 | |||
| 174 | Stack instances where the drift detection operation has failed. | ||
| 175 | |||
| 176 | =item * | ||
| 177 | |||
| 178 | Stack instances currently being checked for drift. | ||
| 179 | |||
| 180 | =back | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head1 SEE ALSO | ||
| 186 | |||
| 187 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 188 | |||
| 189 | =head1 BUGS and CONTRIBUTIONS | ||
| 190 | |||
| 191 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 192 | |||
| 193 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 194 | |||
| 195 | =cut | ||
| 196 |