File Coverage

blib/lib/Paws/CloudTrail/DataResource.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudTrail::DataResource;
2 1     1   486 use Moose;
  1         2  
  1         7  
3             has Type => (is => 'ro', isa => 'Str');
4             has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::CloudTrail::DataResource
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::CloudTrail::DataResource object:
23              
24             $service_obj->Method(Att1 => { Type => $value, ..., Values => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudTrail::DataResource object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->Type
32              
33             =head1 DESCRIPTION
34              
35             The Amazon S3 objects that you specify in your event selectors for your
36             trail to log data events. Data events are object-level API operations
37             that access S3 objects, such as C<GetObject>, C<DeleteObject>, and
38             C<PutObject>. You can specify up to 250 S3 buckets and object prefixes
39             for a trail.
40              
41             Example
42              
43             =over
44              
45             =item 1.
46              
47             You create an event selector for a trail and specify an S3 bucket and
48             an empty prefix, such as C<arn:aws:s3:::bucket-1/>.
49              
50             =item 2.
51              
52             You upload an image file to C<bucket-1>.
53              
54             =item 3.
55              
56             The C<PutObject> API operation occurs on an object in the S3 bucket
57             that you specified in the event selector. The trail processes and logs
58             the event.
59              
60             =item 4.
61              
62             You upload another image file to a different S3 bucket named
63             C<arn:aws:s3:::bucket-2>.
64              
65             =item 5.
66              
67             The event occurs on an object in an S3 bucket that you didn't specify
68             in the event selector. The trail doesnE<rsquo>t log the event.
69              
70             =back
71              
72              
73             =head1 ATTRIBUTES
74              
75              
76             =head2 Type => Str
77              
78             The resource type in which you want to log data events. You can specify
79             only the following value: C<AWS::S3::Object>.
80              
81              
82             =head2 Values => ArrayRef[Str|Undef]
83              
84             A list of ARN-like strings for the specified S3 objects.
85              
86             To log data events for all objects in an S3 bucket, specify the bucket
87             and an empty object prefix such as C<arn:aws:s3:::bucket-1/>. The trail
88             logs data events for all objects in this S3 bucket.
89              
90             To log data events for specific objects, specify the S3 bucket and
91             object prefix such as C<arn:aws:s3:::bucket-1/example-images>. The
92             trail logs data events for objects in this S3 bucket that match the
93             prefix.
94              
95              
96              
97             =head1 SEE ALSO
98              
99             This class forms part of L<Paws>, describing an object used in L<Paws::CloudTrail>
100              
101             =head1 BUGS and CONTRIBUTIONS
102              
103             The source code is located here: https://github.com/pplu/aws-sdk-perl
104              
105             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
106              
107             =cut
108