« blib/lib/Paws/CloudTrail/CreateTrailResponse.pm
↑ Summary
blib/lib/Paws/CloudTrail/DeleteTrail.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudTrail::DataResource; | ||
| 3 | use Moose; | ||
| 4 | has Type => (is => 'ro', isa => 'Str'); | ||
| 5 | has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CloudTrail::DataResource | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::CloudTrail::DataResource object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Type => $value, ..., Values => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudTrail::DataResource object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Type | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The Amazon S3 buckets, AWS Lambda functions, or Amazon DynamoDB tables | ||
| 38 | that you specify in your event selectors for your trail to log data | ||
| 39 | events. Data events provide information about the resource operations | ||
| 40 | performed on or within a resource itself. These are also known as data | ||
| 41 | plane operations. You can specify up to 250 data resources for a trail. | ||
| 42 | |||
| 43 | The total number of allowed data resources is 250. This number can be | ||
| 44 | distributed between 1 and 5 event selectors, but the total cannot | ||
| 45 | exceed 250 across all selectors. | ||
| 46 | |||
| 47 | If you are using advanced event selectors, the maximum total number of | ||
| 48 | values for all conditions, across all advanced event selectors for the | ||
| 49 | trail, is 500. | ||
| 50 | |||
| 51 | The following example demonstrates how logging works when you configure | ||
| 52 | logging of all data events for an S3 bucket named C<bucket-1>. In this | ||
| 53 | example, the CloudTrail user specified an empty prefix, and the option | ||
| 54 | to log both C<Read> and C<Write> data events. | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item 1. | ||
| 59 | |||
| 60 | A user uploads an image file to C<bucket-1>. | ||
| 61 | |||
| 62 | =item 2. | ||
| 63 | |||
| 64 | The C<PutObject> API operation is an Amazon S3 object-level API. It is | ||
| 65 | recorded as a data event in CloudTrail. Because the CloudTrail user | ||
| 66 | specified an S3 bucket with an empty prefix, events that occur on any | ||
| 67 | object in that bucket are logged. The trail processes and logs the | ||
| 68 | event. | ||
| 69 | |||
| 70 | =item 3. | ||
| 71 | |||
| 72 | A user uploads an object to an Amazon S3 bucket named | ||
| 73 | C<arn:aws:s3:::bucket-2>. | ||
| 74 | |||
| 75 | =item 4. | ||
| 76 | |||
| 77 | The C<PutObject> API operation occurred for an object in an S3 bucket | ||
| 78 | that the CloudTrail user didn't specify for the trail. The trail | ||
| 79 | doesnE<rsquo>t log the event. | ||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | The following example demonstrates how logging works when you configure | ||
| 84 | logging of AWS Lambda data events for a Lambda function named | ||
| 85 | I<MyLambdaFunction>, but not for all AWS Lambda functions. | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item 1. | ||
| 90 | |||
| 91 | A user runs a script that includes a call to the I<MyLambdaFunction> | ||
| 92 | function and the I<MyOtherLambdaFunction> function. | ||
| 93 | |||
| 94 | =item 2. | ||
| 95 | |||
| 96 | The C<Invoke> API operation on I<MyLambdaFunction> is an AWS Lambda | ||
| 97 | API. It is recorded as a data event in CloudTrail. Because the | ||
| 98 | CloudTrail user specified logging data events for I<MyLambdaFunction>, | ||
| 99 | any invocations of that function are logged. The trail processes and | ||
| 100 | logs the event. | ||
| 101 | |||
| 102 | =item 3. | ||
| 103 | |||
| 104 | The C<Invoke> API operation on I<MyOtherLambdaFunction> is an AWS | ||
| 105 | Lambda API. Because the CloudTrail user did not specify logging data | ||
| 106 | events for all Lambda functions, the C<Invoke> operation for | ||
| 107 | I<MyOtherLambdaFunction> does not match the function specified for the | ||
| 108 | trail. The trail doesnE<rsquo>t log the event. | ||
| 109 | |||
| 110 | =back | ||
| 111 | |||
| 112 | |||
| 113 | =head1 ATTRIBUTES | ||
| 114 | |||
| 115 | |||
| 116 | =head2 Type => Str | ||
| 117 | |||
| 118 | The resource type in which you want to log data events. You can specify | ||
| 119 | C<AWS::S3::Object>, C<AWS::Lambda::Function>, or | ||
| 120 | C<AWS::DynamoDB::Table> resources. | ||
| 121 | |||
| 122 | The C<AWS::S3Outposts::Object>, C<AWS::ManagedBlockchain::Node>, and | ||
| 123 | C<AWS::S3ObjectLambda::AccessPoint> resource types are not valid in | ||
| 124 | basic event selectors. To log data events on these resource types, use | ||
| 125 | advanced event selectors. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 Values => ArrayRef[Str|Undef] | ||
| 129 | |||
| 130 | An array of Amazon Resource Name (ARN) strings or partial ARN strings | ||
| 131 | for the specified objects. | ||
| 132 | |||
| 133 | =over | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | To log data events for all objects in all S3 buckets in your AWS | ||
| 138 | account, specify the prefix as C<arn:aws:s3:::>. | ||
| 139 | |||
| 140 | This will also enable logging of data event activity performed by any | ||
| 141 | user or role in your AWS account, even if that activity is performed on | ||
| 142 | a bucket that belongs to another AWS account. | ||
| 143 | |||
| 144 | =item * | ||
| 145 | |||
| 146 | To log data events for all objects in an S3 bucket, specify the bucket | ||
| 147 | and an empty object prefix such as C<arn:aws:s3:::bucket-1/>. The trail | ||
| 148 | logs data events for all objects in this S3 bucket. | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | To log data events for specific objects, specify the S3 bucket and | ||
| 153 | object prefix such as C<arn:aws:s3:::bucket-1/example-images>. The | ||
| 154 | trail logs data events for objects in this S3 bucket that match the | ||
| 155 | prefix. | ||
| 156 | |||
| 157 | =item * | ||
| 158 | |||
| 159 | To log data events for all Lambda functions in your AWS account, | ||
| 160 | specify the prefix as C<arn:aws:lambda>. | ||
| 161 | |||
| 162 | This will also enable logging of C<Invoke> activity performed by any | ||
| 163 | user or role in your AWS account, even if that activity is performed on | ||
| 164 | a function that belongs to another AWS account. | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | To log data events for a specific Lambda function, specify the function | ||
| 169 | ARN. | ||
| 170 | |||
| 171 | Lambda function ARNs are exact. For example, if you specify a function | ||
| 172 | ARN I<arn:aws:lambda:us-west-2:111111111111:function:helloworld>, data | ||
| 173 | events will only be logged for | ||
| 174 | I<arn:aws:lambda:us-west-2:111111111111:function:helloworld>. They will | ||
| 175 | not be logged for | ||
| 176 | I<arn:aws:lambda:us-west-2:111111111111:function:helloworld2>. | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | To log data events for all DynamoDB tables in your AWS account, specify | ||
| 181 | the prefix as C<arn:aws:dynamodb>. | ||
| 182 | |||
| 183 | =back | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head1 SEE ALSO | ||
| 189 | |||
| 190 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudTrail> | ||
| 191 | |||
| 192 | =head1 BUGS and CONTRIBUTIONS | ||
| 193 | |||
| 194 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 195 | |||
| 196 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 197 | |||
| 198 | =cut | ||
| 199 |