« blib/lib/Paws/CloudFront/CachePolicyConfig.pm
↑ Summary
blib/lib/Paws/CloudFront/CachePolicyHeadersConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::CachePolicyCookiesConfig; | ||
| 3 | use Moose; | ||
| 4 | has CookieBehavior => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Cookies => (is => 'ro', isa => 'Paws::CloudFront::CookieNames'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CloudFront::CachePolicyCookiesConfig | ||
| 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::CachePolicyCookiesConfig object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { CookieBehavior => $value, ..., Cookies => $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::CachePolicyCookiesConfig object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->CookieBehavior | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | An object that determines whether any cookies in viewer requests (and | ||
| 38 | if so, which cookies) are included in the cache key and automatically | ||
| 39 | included in requests that CloudFront sends to the origin. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> CookieBehavior => Str | ||
| 45 | |||
| 46 | Determines whether any cookies in viewer requests are included in the | ||
| 47 | cache key and automatically included in requests that CloudFront sends | ||
| 48 | to the origin. Valid values are: | ||
| 49 | |||
| 50 | =over | ||
| 51 | |||
| 52 | =item * | ||
| 53 | |||
| 54 | C<none> E<ndash> Cookies in viewer requests are not included in the | ||
| 55 | cache key and are not automatically included in requests that | ||
| 56 | CloudFront sends to the origin. Even when this field is set to C<none>, | ||
| 57 | any cookies that are listed in an C<OriginRequestPolicy> I<are> | ||
| 58 | included in origin requests. | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | C<whitelist> E<ndash> The cookies in viewer requests that are listed in | ||
| 63 | the C<CookieNames> type are included in the cache key and automatically | ||
| 64 | included in requests that CloudFront sends to the origin. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<allExcept> E<ndash> All cookies in viewer requests that are I< B<not> | ||
| 69 | > listed in the C<CookieNames> type are included in the cache key and | ||
| 70 | automatically included in requests that CloudFront sends to the origin. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<all> E<ndash> All cookies in viewer requests are included in the | ||
| 75 | cache key and are automatically included in requests that CloudFront | ||
| 76 | sends to the origin. | ||
| 77 | |||
| 78 | =back | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Cookies => L<Paws::CloudFront::CookieNames> | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |