« blib/lib/Paws/Config/ConfigurationAggregator.pm
↑ Summary
blib/lib/Paws/Config/ConfigurationRecorder.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Config::ConfigurationItem; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', request_name => 'accountId', traits => ['NameInRequest']); | ||
| 5 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 6 | has AvailabilityZone => (is => 'ro', isa => 'Str', request_name => 'availabilityZone', traits => ['NameInRequest']); | ||
| 7 | has AwsRegion => (is => 'ro', isa => 'Str', request_name => 'awsRegion', traits => ['NameInRequest']); | ||
| 8 | has Configuration => (is => 'ro', isa => 'Str', request_name => 'configuration', traits => ['NameInRequest']); | ||
| 9 | has ConfigurationItemCaptureTime => (is => 'ro', isa => 'Str', request_name => 'configurationItemCaptureTime', traits => ['NameInRequest']); | ||
| 10 | has ConfigurationItemMD5Hash => (is => 'ro', isa => 'Str', request_name => 'configurationItemMD5Hash', traits => ['NameInRequest']); | ||
| 11 | has ConfigurationItemStatus => (is => 'ro', isa => 'Str', request_name => 'configurationItemStatus', traits => ['NameInRequest']); | ||
| 12 | has ConfigurationStateId => (is => 'ro', isa => 'Str', request_name => 'configurationStateId', traits => ['NameInRequest']); | ||
| 13 | has RelatedEvents => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'relatedEvents', traits => ['NameInRequest']); | ||
| 14 | has Relationships => (is => 'ro', isa => 'ArrayRef[Paws::Config::Relationship]', request_name => 'relationships', traits => ['NameInRequest']); | ||
| 15 | has ResourceCreationTime => (is => 'ro', isa => 'Str', request_name => 'resourceCreationTime', traits => ['NameInRequest']); | ||
| 16 | has ResourceId => (is => 'ro', isa => 'Str', request_name => 'resourceId', traits => ['NameInRequest']); | ||
| 17 | has ResourceName => (is => 'ro', isa => 'Str', request_name => 'resourceName', traits => ['NameInRequest']); | ||
| 18 | has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest']); | ||
| 19 | has SupplementaryConfiguration => (is => 'ro', isa => 'Paws::Config::SupplementaryConfiguration', request_name => 'supplementaryConfiguration', traits => ['NameInRequest']); | ||
| 20 | has Tags => (is => 'ro', isa => 'Paws::Config::Tags', request_name => 'tags', traits => ['NameInRequest']); | ||
| 21 | has Version => (is => 'ro', isa => 'Str', request_name => 'version', traits => ['NameInRequest']); | ||
| 22 | |||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::Config::ConfigurationItem | ||
| 30 | |||
| 31 | =head1 USAGE | ||
| 32 | |||
| 33 | This class represents one of two things: | ||
| 34 | |||
| 35 | =head3 Arguments in a call to a service | ||
| 36 | |||
| 37 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 38 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 39 | |||
| 40 | As an example, if Att1 is expected to be a Paws::Config::ConfigurationItem object: | ||
| 41 | |||
| 42 | $service_obj->Method(Att1 => { AccountId => $value, ..., Version => $value }); | ||
| 43 | |||
| 44 | =head3 Results returned from an API call | ||
| 45 | |||
| 46 | Use accessors for each attribute. If Att1 is expected to be an Paws::Config::ConfigurationItem object: | ||
| 47 | |||
| 48 | $result = $service_obj->Method(...); | ||
| 49 | $result->Att1->AccountId | ||
| 50 | |||
| 51 | =head1 DESCRIPTION | ||
| 52 | |||
| 53 | A list that contains detailed configurations of a specified resource. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AccountId => Str | ||
| 59 | |||
| 60 | The 12-digit AWS account ID associated with the resource. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Arn => Str | ||
| 64 | |||
| 65 | Amazon Resource Name (ARN) associated with the resource. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 AvailabilityZone => Str | ||
| 69 | |||
| 70 | The Availability Zone associated with the resource. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 AwsRegion => Str | ||
| 74 | |||
| 75 | The region where the resource resides. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Configuration => Str | ||
| 79 | |||
| 80 | The description of the resource configuration. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 ConfigurationItemCaptureTime => Str | ||
| 84 | |||
| 85 | The time when the configuration recording was initiated. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 ConfigurationItemMD5Hash => Str | ||
| 89 | |||
| 90 | Unique MD5 hash that represents the configuration item's state. | ||
| 91 | |||
| 92 | You can use MD5 hash to compare the states of two or more configuration | ||
| 93 | items that are associated with the same resource. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 ConfigurationItemStatus => Str | ||
| 97 | |||
| 98 | The configuration item status. The valid values are: | ||
| 99 | |||
| 100 | =over | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | OK E<ndash> The resource configuration has been updated | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | ResourceDiscovered E<ndash> The resource was newly discovered | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | ResourceNotRecorded E<ndash> The resource was discovered but its | ||
| 113 | configuration was not recorded since the recorder excludes the | ||
| 114 | recording of resources of this type | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | ResourceDeleted E<ndash> The resource was deleted | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | ResourceDeletedNotRecorded E<ndash> The resource was deleted but its | ||
| 123 | configuration was not recorded since the recorder excludes the | ||
| 124 | recording of resources of this type | ||
| 125 | |||
| 126 | =back | ||
| 127 | |||
| 128 | The CIs do not incur any cost. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 ConfigurationStateId => Str | ||
| 132 | |||
| 133 | An identifier that indicates the ordering of the configuration items of | ||
| 134 | a resource. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 RelatedEvents => ArrayRef[Str|Undef] | ||
| 138 | |||
| 139 | A list of CloudTrail event IDs. | ||
| 140 | |||
| 141 | A populated field indicates that the current configuration was | ||
| 142 | initiated by the events recorded in the CloudTrail log. For more | ||
| 143 | information about CloudTrail, see What Is AWS CloudTrail | ||
| 144 | (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html). | ||
| 145 | |||
| 146 | An empty field indicates that the current configuration was not | ||
| 147 | initiated by any event. As of Version 1.3, the relatedEvents field is | ||
| 148 | empty. You can access the LookupEvents API | ||
| 149 | (https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_LookupEvents.html) | ||
| 150 | in the I<AWS CloudTrail API Reference> to retrieve the events for the | ||
| 151 | resource. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 Relationships => ArrayRef[L<Paws::Config::Relationship>] | ||
| 155 | |||
| 156 | A list of related AWS resources. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 ResourceCreationTime => Str | ||
| 160 | |||
| 161 | The time stamp when the resource was created. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 ResourceId => Str | ||
| 165 | |||
| 166 | The ID of the resource (for example, C<sg-xxxxxx>). | ||
| 167 | |||
| 168 | |||
| 169 | =head2 ResourceName => Str | ||
| 170 | |||
| 171 | The custom name of the resource, if available. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 ResourceType => Str | ||
| 175 | |||
| 176 | The type of AWS resource. | ||
| 177 | |||
| 178 | |||
| 179 | =head2 SupplementaryConfiguration => L<Paws::Config::SupplementaryConfiguration> | ||
| 180 | |||
| 181 | Configuration attributes that AWS Config returns for certain resource | ||
| 182 | types to supplement the information returned for the C<configuration> | ||
| 183 | parameter. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 Tags => L<Paws::Config::Tags> | ||
| 187 | |||
| 188 | A mapping of key value tags associated with the resource. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 Version => Str | ||
| 192 | |||
| 193 | The version number of the resource configuration. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | =head1 SEE ALSO | ||
| 198 | |||
| 199 | This class forms part of L<Paws>, describing an object used in L<Paws::Config> | ||
| 200 | |||
| 201 | =head1 BUGS and CONTRIBUTIONS | ||
| 202 | |||
| 203 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 204 | |||
| 205 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 206 | |||
| 207 | =cut | ||
| 208 |