File Coverage

blib/lib/Paws/CloudFront/LoggingConfig.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::CloudFront::LoggingConfig;
2 1     1   294 use Moose;
  1         2  
  1         6  
3             has Bucket => (is => 'ro', isa => 'Str', required => 1);
4             has Enabled => (is => 'ro', isa => 'Bool', required => 1);
5             has IncludeCookies => (is => 'ro', isa => 'Bool', required => 1);
6             has Prefix => (is => 'ro', isa => 'Str', required => 1);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::CloudFront::LoggingConfig
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::CloudFront::LoggingConfig object:
25              
26             $service_obj->Method(Att1 => { Bucket => $value, ..., Prefix => $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::CloudFront::LoggingConfig object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->Bucket
34              
35             =head1 DESCRIPTION
36              
37             A complex type that controls whether access logs are written for the
38             distribution.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> Bucket => Str
44              
45             The Amazon S3 bucket to store the access logs in, for example,
46             C<myawslogbucket.s3.amazonaws.com>.
47              
48              
49             =head2 B<REQUIRED> Enabled => Bool
50              
51             Specifies whether you want CloudFront to save access logs to an Amazon
52             S3 bucket. If you do not want to enable logging when you create a
53             distribution or if you want to disable logging for an existing
54             distribution, specify C<false> for C<Enabled>, and specify empty
55             C<Bucket> and C<Prefix> elements. If you specify C<false> for
56             C<Enabled> but you specify values for C<Bucket>, C<prefix>, and
57             C<IncludeCookies>, the values are automatically deleted.
58              
59              
60             =head2 B<REQUIRED> IncludeCookies => Bool
61              
62             Specifies whether you want CloudFront to include cookies in access
63             logs, specify C<true> for C<IncludeCookies>. If you choose to include
64             cookies in logs, CloudFront logs all cookies regardless of how you
65             configure the cache behaviors for this distribution. If you do not want
66             to include cookies when you create a distribution or if you want to
67             disable include cookies for an existing distribution, specify C<false>
68             for C<IncludeCookies>.
69              
70              
71             =head2 B<REQUIRED> Prefix => Str
72              
73             An optional string that you want CloudFront to prefix to the access log
74             C<filenames> for this distribution, for example, C<myprefix/>. If you
75             want to enable logging, but you do not want to specify a prefix, you
76             still must include an empty C<Prefix> element in the C<Logging>
77             element.
78              
79              
80              
81             =head1 SEE ALSO
82              
83             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront>
84              
85             =head1 BUGS and CONTRIBUTIONS
86              
87             The source code is located here: https://github.com/pplu/aws-sdk-perl
88              
89             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
90              
91             =cut
92