« blib/lib/Paws/CloudTrail/AdvancedEventSelector.pm
↑ Summary
blib/lib/Paws/CloudTrail/CreateTrail.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudTrail::AdvancedFieldSelector; | ||
| 3 | use Moose; | ||
| 4 | has EndsWith => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has Equals => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has Field => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has NotEndsWith => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has NotEquals => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has NotStartsWith => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has StartsWith => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::CloudTrail::AdvancedFieldSelector | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::CloudTrail::AdvancedFieldSelector object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { EndsWith => $value, ..., StartsWith => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudTrail::AdvancedFieldSelector object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->EndsWith | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | A single selector statement in an advanced event selector. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 EndsWith => ArrayRef[Str|Undef] | ||
| 48 | |||
| 49 | An operator that includes events that match the last few characters of | ||
| 50 | the event record field specified as the value of C<Field>. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Equals => ArrayRef[Str|Undef] | ||
| 54 | |||
| 55 | An operator that includes events that match the exact value of the | ||
| 56 | event record field specified as the value of C<Field>. This is the only | ||
| 57 | valid operator that you can use with the C<readOnly>, C<eventCategory>, | ||
| 58 | and C<resources.type> fields. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Field => Str | ||
| 62 | |||
| 63 | A field in an event record on which to filter events to be logged. | ||
| 64 | Supported fields include C<readOnly>, C<eventCategory>, C<eventSource> | ||
| 65 | (for management events), C<eventName>, C<resources.type>, and | ||
| 66 | C<resources.ARN>. | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | B<C<readOnly> > - Optional. Can be set to C<Equals> a value of C<true> | ||
| 73 | or C<false>. A value of C<false> logs both C<read> and C<write> events. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | B<C<eventSource> > - For filtering management events only. This can be | ||
| 78 | set only to C<NotEquals> C<kms.amazonaws.com>. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | B<C<eventName> > - Can use any operator. You can use it to lter in or | ||
| 83 | lter out any data event logged to CloudTrail, such as C<PutBucket>. You | ||
| 84 | can have multiple values for this eld, separated by commas. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | B<C<eventCategory> > - This is required. It must be set to C<Equals>, | ||
| 89 | and the value must be C<Management> or C<Data>. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | B<C<resources.type> > - This eld is required. C<resources.type> can | ||
| 94 | only use the C<Equals> operator, and the value can be one of the | ||
| 95 | following: C<AWS::S3::Object>, C<AWS::Lambda::Function>, | ||
| 96 | C<AWS::DynamoDB::Table>, C<AWS::S3Outposts::Object>, | ||
| 97 | C<AWS::ManagedBlockchain::Node>, or | ||
| 98 | C<AWS::S3ObjectLambda::AccessPoint>. You can have only one | ||
| 99 | C<resources.type> eld per selector. To log data events on more than one | ||
| 100 | resource type, add another selector. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | B<C<resources.ARN> > - You can use any operator with resources.ARN, but | ||
| 105 | if you use C<Equals> or C<NotEquals>, the value must exactly match the | ||
| 106 | ARN of a valid resource of the type you've specied in the template as | ||
| 107 | the value of resources.type. For example, if resources.type equals | ||
| 108 | C<AWS::S3::Object>, the ARN must be in one of the following formats. To | ||
| 109 | log all data events for all objects in a specific S3 bucket, use the | ||
| 110 | C<StartsWith> operator, and include only the bucket ARN as the matching | ||
| 111 | value. | ||
| 112 | |||
| 113 | The trailing slash is intentional; do not exclude it. | ||
| 114 | |||
| 115 | =over | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<arn:partition:s3:::bucket_name/> | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<arn:partition:s3:::bucket_name/object_or_file_name/> | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | When resources.type equals C<AWS::Lambda::Function>, and the operator | ||
| 128 | is set to C<Equals> or C<NotEquals>, the ARN must be in the following | ||
| 129 | format: | ||
| 130 | |||
| 131 | =over | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | C<arn:partition:lambda:region:account_ID:function:function_name> | ||
| 136 | |||
| 137 | =back | ||
| 138 | |||
| 139 | When resources.type equals C<AWS::DynamoDB::Table>, and the operator is | ||
| 140 | set to C<Equals> or C<NotEquals>, the ARN must be in the following | ||
| 141 | format: | ||
| 142 | |||
| 143 | =over | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | C<arn:partition:dynamodb:region:account_ID:table:table_name> | ||
| 148 | |||
| 149 | =back | ||
| 150 | |||
| 151 | When C<resources.type> equals C<AWS::S3Outposts::Object>, and the | ||
| 152 | operator is set to C<Equals> or C<NotEquals>, the ARN must be in the | ||
| 153 | following format: | ||
| 154 | |||
| 155 | =over | ||
| 156 | |||
| 157 | =item * | ||
| 158 | |||
| 159 | C<arn:partition:s3-outposts:region:E<gt>account_ID:object_path> | ||
| 160 | |||
| 161 | =back | ||
| 162 | |||
| 163 | When C<resources.type> equals C<AWS::ManagedBlockchain::Node>, and the | ||
| 164 | operator is set to C<Equals> or C<NotEquals>, the ARN must be in the | ||
| 165 | following format: | ||
| 166 | |||
| 167 | =over | ||
| 168 | |||
| 169 | =item * | ||
| 170 | |||
| 171 | C<arn:partition:managedblockchain:region:account_ID:nodes/node_ID> | ||
| 172 | |||
| 173 | =back | ||
| 174 | |||
| 175 | When C<resources.type> equals C<AWS::S3ObjectLambda::AccessPoint>, and | ||
| 176 | the operator is set to C<Equals> or C<NotEquals>, the ARN must be in | ||
| 177 | the following format: | ||
| 178 | |||
| 179 | =over | ||
| 180 | |||
| 181 | =item * | ||
| 182 | |||
| 183 | C<arn:partition:s3-object-lambda:region:account_ID:accesspoint/access_point_name> | ||
| 184 | |||
| 185 | =back | ||
| 186 | |||
| 187 | =back | ||
| 188 | |||
| 189 | |||
| 190 | |||
| 191 | =head2 NotEndsWith => ArrayRef[Str|Undef] | ||
| 192 | |||
| 193 | An operator that excludes events that match the last few characters of | ||
| 194 | the event record field specified as the value of C<Field>. | ||
| 195 | |||
| 196 | |||
| 197 | =head2 NotEquals => ArrayRef[Str|Undef] | ||
| 198 | |||
| 199 | An operator that excludes events that match the exact value of the | ||
| 200 | event record field specified as the value of C<Field>. | ||
| 201 | |||
| 202 | |||
| 203 | =head2 NotStartsWith => ArrayRef[Str|Undef] | ||
| 204 | |||
| 205 | An operator that excludes events that match the first few characters of | ||
| 206 | the event record field specified as the value of C<Field>. | ||
| 207 | |||
| 208 | |||
| 209 | =head2 StartsWith => ArrayRef[Str|Undef] | ||
| 210 | |||
| 211 | An operator that includes events that match the first few characters of | ||
| 212 | the event record field specified as the value of C<Field>. | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | =head1 SEE ALSO | ||
| 217 | |||
| 218 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudTrail> | ||
| 219 | |||
| 220 | =head1 BUGS and CONTRIBUTIONS | ||
| 221 | |||
| 222 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 223 | |||
| 224 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 225 | |||
| 226 | =cut | ||
| 227 |