« blib/lib/Paws/AccessAnalyzer/AccessPreview.pm
↑ Summary
blib/lib/Paws/AccessAnalyzer/AccessPreviewStatusReason.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AccessAnalyzer::AccessPreviewFinding; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'action', traits => ['NameInRequest']); | ||
| 5 | has ChangeType => (is => 'ro', isa => 'Str', request_name => 'changeType', traits => ['NameInRequest'], required => 1); | ||
| 6 | has Condition => (is => 'ro', isa => 'Paws::AccessAnalyzer::ConditionKeyMap', request_name => 'condition', traits => ['NameInRequest']); | ||
| 7 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest'], required => 1); | ||
| 8 | has Error => (is => 'ro', isa => 'Str', request_name => 'error', traits => ['NameInRequest']); | ||
| 9 | has ExistingFindingId => (is => 'ro', isa => 'Str', request_name => 'existingFindingId', traits => ['NameInRequest']); | ||
| 10 | has ExistingFindingStatus => (is => 'ro', isa => 'Str', request_name => 'existingFindingStatus', traits => ['NameInRequest']); | ||
| 11 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest'], required => 1); | ||
| 12 | has IsPublic => (is => 'ro', isa => 'Bool', request_name => 'isPublic', traits => ['NameInRequest']); | ||
| 13 | has Principal => (is => 'ro', isa => 'Paws::AccessAnalyzer::PrincipalMap', request_name => 'principal', traits => ['NameInRequest']); | ||
| 14 | has Resource => (is => 'ro', isa => 'Str', request_name => 'resource', traits => ['NameInRequest']); | ||
| 15 | has ResourceOwnerAccount => (is => 'ro', isa => 'Str', request_name => 'resourceOwnerAccount', traits => ['NameInRequest'], required => 1); | ||
| 16 | has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest'], required => 1); | ||
| 17 | has Sources => (is => 'ro', isa => 'ArrayRef[Paws::AccessAnalyzer::FindingSource]', request_name => 'sources', traits => ['NameInRequest']); | ||
| 18 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest'], required => 1); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::AccessAnalyzer::AccessPreviewFinding | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::AccessAnalyzer::AccessPreviewFinding object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { Action => $value, ..., Status => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::AccessAnalyzer::AccessPreviewFinding object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->Action | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | An access preview finding generated by the access preview. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Action => ArrayRef[Str|Undef] | ||
| 56 | |||
| 57 | The action in the analyzed policy statement that an external principal | ||
| 58 | has permission to perform. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> ChangeType => Str | ||
| 62 | |||
| 63 | Provides context on how the access preview finding compares to existing | ||
| 64 | access identified in Access Analyzer. | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | C<New> - The finding is for newly-introduced access. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<Unchanged> - The preview finding is an existing finding that would | ||
| 75 | remain unchanged. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<Changed> - The preview finding is an existing finding with a change | ||
| 80 | in status. | ||
| 81 | |||
| 82 | =back | ||
| 83 | |||
| 84 | For example, a C<Changed> finding with preview status C<Resolved> and | ||
| 85 | existing status C<Active> indicates the existing C<Active> finding | ||
| 86 | would become C<Resolved> as a result of the proposed permissions | ||
| 87 | change. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 Condition => L<Paws::AccessAnalyzer::ConditionKeyMap> | ||
| 91 | |||
| 92 | The condition in the analyzed policy statement that resulted in a | ||
| 93 | finding. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> CreatedAt => Str | ||
| 97 | |||
| 98 | The time at which the access preview finding was created. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 Error => Str | ||
| 102 | |||
| 103 | An error. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 ExistingFindingId => Str | ||
| 107 | |||
| 108 | The existing ID of the finding in Access Analyzer, provided only for | ||
| 109 | existing findings. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 ExistingFindingStatus => Str | ||
| 113 | |||
| 114 | The existing status of the finding, provided only for existing | ||
| 115 | findings. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 B<REQUIRED> Id => Str | ||
| 119 | |||
| 120 | The ID of the access preview finding. This ID uniquely identifies the | ||
| 121 | element in the list of access preview findings and is not related to | ||
| 122 | the finding ID in Access Analyzer. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 IsPublic => Bool | ||
| 126 | |||
| 127 | Indicates whether the policy that generated the finding allows public | ||
| 128 | access to the resource. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 Principal => L<Paws::AccessAnalyzer::PrincipalMap> | ||
| 132 | |||
| 133 | The external principal that has access to a resource within the zone of | ||
| 134 | trust. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 Resource => Str | ||
| 138 | |||
| 139 | The resource that an external principal has access to. This is the | ||
| 140 | resource associated with the access preview. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 B<REQUIRED> ResourceOwnerAccount => Str | ||
| 144 | |||
| 145 | The AWS account ID that owns the resource. For most AWS resources, the | ||
| 146 | owning account is the account in which the resource was created. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 B<REQUIRED> ResourceType => Str | ||
| 150 | |||
| 151 | The type of the resource that can be accessed in the finding. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 Sources => ArrayRef[L<Paws::AccessAnalyzer::FindingSource>] | ||
| 155 | |||
| 156 | The sources of the finding. This indicates how the access that | ||
| 157 | generated the finding is granted. It is populated for Amazon S3 bucket | ||
| 158 | findings. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 B<REQUIRED> Status => Str | ||
| 162 | |||
| 163 | The preview status of the finding. This is what the status of the | ||
| 164 | finding would be after permissions deployment. For example, a | ||
| 165 | C<Changed> finding with preview status C<Resolved> and existing status | ||
| 166 | C<Active> indicates the existing C<Active> finding would become | ||
| 167 | C<Resolved> as a result of the proposed permissions change. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head1 SEE ALSO | ||
| 172 | |||
| 173 | This class forms part of L<Paws>, describing an object used in L<Paws::AccessAnalyzer> | ||
| 174 | |||
| 175 | =head1 BUGS and CONTRIBUTIONS | ||
| 176 | |||
| 177 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 178 | |||
| 179 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 180 | |||
| 181 | =cut | ||
| 182 |