File Coverage

blib/lib/Paws/CloudFront/CookiePreference.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::CookiePreference;
2 1     1   373 use Moose;
  1         2  
  1         7  
3             has Forward => (is => 'ro', isa => 'Str', required => 1);
4             has WhitelistedNames => (is => 'ro', isa => 'Paws::CloudFront::CookieNames');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::CloudFront::CookiePreference
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::CloudFront::CookiePreference object:
23              
24             $service_obj->Method(Att1 => { Forward => $value, ..., WhitelistedNames => $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::CloudFront::CookiePreference object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->Forward
32              
33             =head1 DESCRIPTION
34              
35             A complex type that specifies whether you want CloudFront to forward
36             cookies to the origin and, if so, which ones. For more information
37             about forwarding cookies to the origin, see How CloudFront Forwards,
38             Caches, and Logs Cookies in the I<Amazon CloudFront Developer Guide>.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> Forward => Str
44              
45             Specifies which cookies to forward to the origin for this cache
46             behavior: all, none, or the list of cookies specified in the
47             C<WhitelistedNames> complex type.
48              
49             Amazon S3 doesn't process cookies. When the cache behavior is
50             forwarding requests to an Amazon S3 origin, specify none for the
51             C<Forward> element.
52              
53              
54             =head2 WhitelistedNames => L<Paws::CloudFront::CookieNames>
55              
56             Required if you specify C<whitelist> for the value of C<Forward:>. A
57             complex type that specifies how many different cookies you want
58             CloudFront to forward to the origin for this cache behavior and, if you
59             want to forward selected cookies, the names of those cookies.
60              
61             If you specify C<all> or none for the value of C<Forward>, omit
62             C<WhitelistedNames>. If you change the value of C<Forward> from
63             C<whitelist> to all or none and you don't delete the
64             C<WhitelistedNames> element and its child elements, CloudFront deletes
65             them automatically.
66              
67             For the current limit on the number of cookie names that you can
68             whitelist for each cache behavior, see Amazon CloudFront Limits in the
69             I<AWS General Reference>.
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84