| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::CookiePreference; | ||
| 3 | use Moose; | ||
| 4 | has Forward => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has WhitelistedNames => (is => 'ro', isa => 'Paws::CloudFront::CookieNames'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CloudFront::CookiePreference | ||
| 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::CookiePreference object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Forward => $value, ..., WhitelistedNames => $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::CookiePreference object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Forward | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | This field is deprecated. We recommend that you use a cache policy or | ||
| 38 | an origin request policy instead of this field. | ||
| 39 | |||
| 40 | If you want to include cookies in the cache key, use C<CookiesConfig> | ||
| 41 | in a cache policy. See C<CachePolicy>. | ||
| 42 | |||
| 43 | If you want to send cookies to the origin but not include them in the | ||
| 44 | cache key, use C<CookiesConfig> in an origin request policy. See | ||
| 45 | C<OriginRequestPolicy>. | ||
| 46 | |||
| 47 | A complex type that specifies whether you want CloudFront to forward | ||
| 48 | cookies to the origin and, if so, which ones. For more information | ||
| 49 | about forwarding cookies to the origin, see Caching Content Based on | ||
| 50 | Cookies | ||
| 51 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) | ||
| 52 | in the I<Amazon CloudFront Developer Guide>. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> Forward => Str | ||
| 58 | |||
| 59 | This field is deprecated. We recommend that you use a cache policy or | ||
| 60 | an origin request policy instead of this field. | ||
| 61 | |||
| 62 | If you want to include cookies in the cache key, use a cache policy. | ||
| 63 | For more information, see Creating cache policies | ||
| 64 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) | ||
| 65 | in the I<Amazon CloudFront Developer Guide>. | ||
| 66 | |||
| 67 | If you want to send cookies to the origin but not include them in the | ||
| 68 | cache key, use origin request policy. For more information, see | ||
| 69 | Creating origin request policies | ||
| 70 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) | ||
| 71 | in the I<Amazon CloudFront Developer Guide>. | ||
| 72 | |||
| 73 | Specifies which cookies to forward to the origin for this cache | ||
| 74 | behavior: all, none, or the list of cookies specified in the | ||
| 75 | C<WhitelistedNames> complex type. | ||
| 76 | |||
| 77 | Amazon S3 doesn't process cookies. When the cache behavior is | ||
| 78 | forwarding requests to an Amazon S3 origin, specify none for the | ||
| 79 | C<Forward> element. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 WhitelistedNames => L<Paws::CloudFront::CookieNames> | ||
| 83 | |||
| 84 | This field is deprecated. We recommend that you use a cache policy or | ||
| 85 | an origin request policy instead of this field. | ||
| 86 | |||
| 87 | If you want to include cookies in the cache key, use a cache policy. | ||
| 88 | For more information, see Creating cache policies | ||
| 89 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) | ||
| 90 | in the I<Amazon CloudFront Developer Guide>. | ||
| 91 | |||
| 92 | If you want to send cookies to the origin but not include them in the | ||
| 93 | cache key, use an origin request policy. For more information, see | ||
| 94 | Creating origin request policies | ||
| 95 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) | ||
| 96 | in the I<Amazon CloudFront Developer Guide>. | ||
| 97 | |||
| 98 | Required if you specify C<whitelist> for the value of C<Forward>. A | ||
| 99 | complex type that specifies how many different cookies you want | ||
| 100 | CloudFront to forward to the origin for this cache behavior and, if you | ||
| 101 | want to forward selected cookies, the names of those cookies. | ||
| 102 | |||
| 103 | If you specify C<all> or C<none> for the value of C<Forward>, omit | ||
| 104 | C<WhitelistedNames>. If you change the value of C<Forward> from | ||
| 105 | C<whitelist> to C<all> or C<none> and you don't delete the | ||
| 106 | C<WhitelistedNames> element and its child elements, CloudFront deletes | ||
| 107 | them automatically. | ||
| 108 | |||
| 109 | For the current limit on the number of cookie names that you can | ||
| 110 | whitelist for each cache behavior, see CloudFront Limits | ||
| 111 | (https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront) | ||
| 112 | in the I<AWS General Reference>. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |