« blib/lib/Paws/CloudFront/ListTagsForResourceResult.pm
↑ Summary
blib/lib/Paws/CloudFront/MonitoringSubscription.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::LoggingConfig; | ||
| 3 | use Moose; | ||
| 4 | has Bucket => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Enabled => (is => 'ro', isa => 'Bool', required => 1); | ||
| 6 | has IncludeCookies => (is => 'ro', isa => 'Bool', required => 1); | ||
| 7 | has Prefix => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::CloudFront::LoggingConfig | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::CloudFront::LoggingConfig object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Bucket => $value, ..., Prefix => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::LoggingConfig object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Bucket | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | A complex type that controls whether access logs are written for the | ||
| 40 | distribution. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> Bucket => Str | ||
| 46 | |||
| 47 | The Amazon S3 bucket to store the access logs in, for example, | ||
| 48 | C<myawslogbucket.s3.amazonaws.com>. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> Enabled => Bool | ||
| 52 | |||
| 53 | Specifies whether you want CloudFront to save access logs to an Amazon | ||
| 54 | S3 bucket. If you don't want to enable logging when you create a | ||
| 55 | distribution or if you want to disable logging for an existing | ||
| 56 | distribution, specify C<false> for C<Enabled>, and specify empty | ||
| 57 | C<Bucket> and C<Prefix> elements. If you specify C<false> for | ||
| 58 | C<Enabled> but you specify values for C<Bucket>, C<prefix>, and | ||
| 59 | C<IncludeCookies>, the values are automatically deleted. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> IncludeCookies => Bool | ||
| 63 | |||
| 64 | Specifies whether you want CloudFront to include cookies in access | ||
| 65 | logs, specify C<true> for C<IncludeCookies>. If you choose to include | ||
| 66 | cookies in logs, CloudFront logs all cookies regardless of how you | ||
| 67 | configure the cache behaviors for this distribution. If you don't want | ||
| 68 | to include cookies when you create a distribution or if you want to | ||
| 69 | disable include cookies for an existing distribution, specify C<false> | ||
| 70 | for C<IncludeCookies>. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> Prefix => Str | ||
| 74 | |||
| 75 | An optional string that you want CloudFront to prefix to the access log | ||
| 76 | C<filenames> for this distribution, for example, C<myprefix/>. If you | ||
| 77 | want to enable logging, but you don't want to specify a prefix, you | ||
| 78 | still must include an empty C<Prefix> element in the C<Logging> | ||
| 79 | element. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |