« blib/lib/Paws/CloudFormation/StackResourceDetail.pm
↑ Summary
blib/lib/Paws/CloudFormation/StackResourceDriftInformation.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFormation::StackResourceDrift; | ||
| 3 | use Moose; | ||
| 4 | has ActualProperties => (is => 'ro', isa => 'Str'); | ||
| 5 | has ExpectedProperties => (is => 'ro', isa => 'Str'); | ||
| 6 | has LogicalResourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ModuleInfo => (is => 'ro', isa => 'Paws::CloudFormation::ModuleInfo'); | ||
| 8 | has PhysicalResourceId => (is => 'ro', isa => 'Str'); | ||
| 9 | has PhysicalResourceIdContext => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::PhysicalResourceIdContextKeyValuePair]'); | ||
| 10 | has PropertyDifferences => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::PropertyDifference]'); | ||
| 11 | has ResourceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has StackId => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has StackResourceDriftStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has Timestamp => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudFormation::StackResourceDrift | ||
| 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::StackResourceDrift object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { ActualProperties => $value, ..., Timestamp => $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::StackResourceDrift object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->ActualProperties | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Contains the drift information for a resource that has been checked for | ||
| 47 | drift. This includes actual and expected property values for resources | ||
| 48 | in which AWS CloudFormation has detected drift. Only resource | ||
| 49 | properties explicitly defined in the stack template are checked for | ||
| 50 | drift. For more information, see Detecting Unregulated Configuration | ||
| 51 | Changes to Stacks and Resources | ||
| 52 | (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html). | ||
| 53 | |||
| 54 | Resources that do not currently support drift detection cannot be | ||
| 55 | checked. For a list of resources that support drift detection, see | ||
| 56 | Resources that Support Drift Detection | ||
| 57 | (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html). | ||
| 58 | |||
| 59 | Use DetectStackResourceDrift to detect drift on individual resources, | ||
| 60 | or DetectStackDrift to detect drift on all resources in a given stack | ||
| 61 | that support drift detection. | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ActualProperties => Str | ||
| 67 | |||
| 68 | A JSON structure containing the actual property values of the stack | ||
| 69 | resource. | ||
| 70 | |||
| 71 | For resources whose C<StackResourceDriftStatus> is C<DELETED>, this | ||
| 72 | structure will not be present. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 ExpectedProperties => Str | ||
| 76 | |||
| 77 | A JSON structure containing the expected property values of the stack | ||
| 78 | resource, as defined in the stack template and any values specified as | ||
| 79 | template parameters. | ||
| 80 | |||
| 81 | For resources whose C<StackResourceDriftStatus> is C<DELETED>, this | ||
| 82 | structure will not be present. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> LogicalResourceId => Str | ||
| 86 | |||
| 87 | The logical name of the resource specified in the template. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ModuleInfo => L<Paws::CloudFormation::ModuleInfo> | ||
| 91 | |||
| 92 | Contains information about the module from which the resource was | ||
| 93 | created, if the resource was created from a module included in the | ||
| 94 | stack template. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 PhysicalResourceId => Str | ||
| 98 | |||
| 99 | The name or unique identifier that corresponds to a physical instance | ||
| 100 | ID of a resource supported by AWS CloudFormation. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 PhysicalResourceIdContext => ArrayRef[L<Paws::CloudFormation::PhysicalResourceIdContextKeyValuePair>] | ||
| 104 | |||
| 105 | Context information that enables AWS CloudFormation to uniquely | ||
| 106 | identify a resource. AWS CloudFormation uses context key-value pairs in | ||
| 107 | cases where a resource's logical and physical IDs are not enough to | ||
| 108 | uniquely identify that resource. Each context key-value pair specifies | ||
| 109 | a unique resource that contains the targeted resource. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 PropertyDifferences => ArrayRef[L<Paws::CloudFormation::PropertyDifference>] | ||
| 113 | |||
| 114 | A collection of the resource properties whose actual values differ from | ||
| 115 | their expected values. These will be present only for resources whose | ||
| 116 | C<StackResourceDriftStatus> is C<MODIFIED>. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 B<REQUIRED> ResourceType => Str | ||
| 120 | |||
| 121 | The type of the resource. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> StackId => Str | ||
| 125 | |||
| 126 | The ID of the stack. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 B<REQUIRED> StackResourceDriftStatus => Str | ||
| 130 | |||
| 131 | Status of the resource's actual configuration compared to its expected | ||
| 132 | configuration | ||
| 133 | |||
| 134 | =over | ||
| 135 | |||
| 136 | =item * | ||
| 137 | |||
| 138 | C<DELETED>: The resource differs from its expected template | ||
| 139 | configuration because the resource has been deleted. | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | C<MODIFIED>: One or more resource properties differ from their expected | ||
| 144 | values (as defined in the stack template and any values specified as | ||
| 145 | template parameters). | ||
| 146 | |||
| 147 | =item * | ||
| 148 | |||
| 149 | C<IN_SYNC>: The resources's actual configuration matches its expected | ||
| 150 | template configuration. | ||
| 151 | |||
| 152 | =item * | ||
| 153 | |||
| 154 | C<NOT_CHECKED>: AWS CloudFormation does not currently return this | ||
| 155 | value. | ||
| 156 | |||
| 157 | =back | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 B<REQUIRED> Timestamp => Str | ||
| 162 | |||
| 163 | Time at which AWS CloudFormation performed drift detection on the stack | ||
| 164 | resource. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | =head1 SEE ALSO | ||
| 169 | |||
| 170 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFormation> | ||
| 171 | |||
| 172 | =head1 BUGS and CONTRIBUTIONS | ||
| 173 | |||
| 174 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 175 | |||
| 176 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 177 | |||
| 178 | =cut | ||
| 179 |