| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::ParametersInCacheKeyAndForwardedToOrigin; | ||
| 3 | use Moose; | ||
| 4 | has CookiesConfig => (is => 'ro', isa => 'Paws::CloudFront::CachePolicyCookiesConfig', required => 1); | ||
| 5 | has EnableAcceptEncodingBrotli => (is => 'ro', isa => 'Bool'); | ||
| 6 | has EnableAcceptEncodingGzip => (is => 'ro', isa => 'Bool', required => 1); | ||
| 7 | has HeadersConfig => (is => 'ro', isa => 'Paws::CloudFront::CachePolicyHeadersConfig', required => 1); | ||
| 8 | has QueryStringsConfig => (is => 'ro', isa => 'Paws::CloudFront::CachePolicyQueryStringsConfig', required => 1); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::CloudFront::ParametersInCacheKeyAndForwardedToOrigin | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::CloudFront::ParametersInCacheKeyAndForwardedToOrigin object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CookiesConfig => $value, ..., QueryStringsConfig => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::ParametersInCacheKeyAndForwardedToOrigin object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CookiesConfig | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | This object determines the values that CloudFront includes in the cache | ||
| 41 | key. These values can include HTTP headers, cookies, and URL query | ||
| 42 | strings. CloudFront uses the cache key to find an object in its cache | ||
| 43 | that it can return to the viewer. | ||
| 44 | |||
| 45 | The headers, cookies, and query strings that are included in the cache | ||
| 46 | key are automatically included in requests that CloudFront sends to the | ||
| 47 | origin. CloudFront sends a request when it canE<rsquo>t find an object | ||
| 48 | in its cache that matches the requestE<rsquo>s cache key. If you want | ||
| 49 | to send values to the origin but I<not> include them in the cache key, | ||
| 50 | use C<OriginRequestPolicy>. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> CookiesConfig => L<Paws::CloudFront::CachePolicyCookiesConfig> | ||
| 56 | |||
| 57 | An object that determines whether any cookies in viewer requests (and | ||
| 58 | if so, which cookies) are included in the cache key and automatically | ||
| 59 | included in requests that CloudFront sends to the origin. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 EnableAcceptEncodingBrotli => Bool | ||
| 63 | |||
| 64 | A flag that can affect whether the C<Accept-Encoding> HTTP header is | ||
| 65 | included in the cache key and included in requests that CloudFront | ||
| 66 | sends to the origin. | ||
| 67 | |||
| 68 | This field is related to the C<EnableAcceptEncodingGzip> field. If one | ||
| 69 | or both of these fields is C<true> I<and> the viewer request includes | ||
| 70 | the C<Accept-Encoding> header, then CloudFront does the following: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | Normalizes the value of the viewerE<rsquo>s C<Accept-Encoding> header | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | Includes the normalized header in the cache key | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | Includes the normalized header in the request to the origin, if a | ||
| 85 | request is necessary | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | For more information, see Compression support | ||
| 90 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) | ||
| 91 | in the I<Amazon CloudFront Developer Guide>. | ||
| 92 | |||
| 93 | If you set this value to C<true>, and this cache behavior also has an | ||
| 94 | origin request policy attached, do not include the C<Accept-Encoding> | ||
| 95 | header in the origin request policy. CloudFront always includes the | ||
| 96 | C<Accept-Encoding> header in origin requests when the value of this | ||
| 97 | field is C<true>, so including this header in an origin request policy | ||
| 98 | has no effect. | ||
| 99 | |||
| 100 | If both of these fields are C<false>, then CloudFront treats the | ||
| 101 | C<Accept-Encoding> header the same as any other HTTP header in the | ||
| 102 | viewer request. By default, itE<rsquo>s not included in the cache key | ||
| 103 | and itE<rsquo>s not included in origin requests. In this case, you can | ||
| 104 | manually add C<Accept-Encoding> to the headers whitelist like any other | ||
| 105 | HTTP header. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 B<REQUIRED> EnableAcceptEncodingGzip => Bool | ||
| 109 | |||
| 110 | A flag that can affect whether the C<Accept-Encoding> HTTP header is | ||
| 111 | included in the cache key and included in requests that CloudFront | ||
| 112 | sends to the origin. | ||
| 113 | |||
| 114 | This field is related to the C<EnableAcceptEncodingBrotli> field. If | ||
| 115 | one or both of these fields is C<true> I<and> the viewer request | ||
| 116 | includes the C<Accept-Encoding> header, then CloudFront does the | ||
| 117 | following: | ||
| 118 | |||
| 119 | =over | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | Normalizes the value of the viewerE<rsquo>s C<Accept-Encoding> header | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | Includes the normalized header in the cache key | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | Includes the normalized header in the request to the origin, if a | ||
| 132 | request is necessary | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | For more information, see Compression support | ||
| 137 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) | ||
| 138 | in the I<Amazon CloudFront Developer Guide>. | ||
| 139 | |||
| 140 | If you set this value to C<true>, and this cache behavior also has an | ||
| 141 | origin request policy attached, do not include the C<Accept-Encoding> | ||
| 142 | header in the origin request policy. CloudFront always includes the | ||
| 143 | C<Accept-Encoding> header in origin requests when the value of this | ||
| 144 | field is C<true>, so including this header in an origin request policy | ||
| 145 | has no effect. | ||
| 146 | |||
| 147 | If both of these fields are C<false>, then CloudFront treats the | ||
| 148 | C<Accept-Encoding> header the same as any other HTTP header in the | ||
| 149 | viewer request. By default, itE<rsquo>s not included in the cache key | ||
| 150 | and itE<rsquo>s not included in origin requests. In this case, you can | ||
| 151 | manually add C<Accept-Encoding> to the headers whitelist like any other | ||
| 152 | HTTP header. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 B<REQUIRED> HeadersConfig => L<Paws::CloudFront::CachePolicyHeadersConfig> | ||
| 156 | |||
| 157 | An object that determines whether any HTTP headers (and if so, which | ||
| 158 | headers) are included in the cache key and automatically included in | ||
| 159 | requests that CloudFront sends to the origin. | ||
| 160 | |||
| 161 | |||
| 162 | =head2 B<REQUIRED> QueryStringsConfig => L<Paws::CloudFront::CachePolicyQueryStringsConfig> | ||
| 163 | |||
| 164 | An object that determines whether any URL query strings in viewer | ||
| 165 | requests (and if so, which query strings) are included in the cache key | ||
| 166 | and automatically included in requests that CloudFront sends to the | ||
| 167 | origin. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head1 SEE ALSO | ||
| 172 | |||
| 173 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 174 | |||
| 175 | =head1 BUGS and CONTRIBUTIONS | ||
| 176 | |||
| 177 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 178 | |||
| 179 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 180 | |||
| 181 | =cut | ||
| 182 |