« blib/lib/Paws/CloudFront/FieldPatterns.pm
↑ Summary
blib/lib/Paws/CloudFront/FunctionAssociation.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::ForwardedValues; | ||
| 3 | use Moose; | ||
| 4 | has Cookies => (is => 'ro', isa => 'Paws::CloudFront::CookiePreference', required => 1); | ||
| 5 | has Headers => (is => 'ro', isa => 'Paws::CloudFront::Headers'); | ||
| 6 | has QueryString => (is => 'ro', isa => 'Bool', required => 1); | ||
| 7 | has QueryStringCacheKeys => (is => 'ro', isa => 'Paws::CloudFront::QueryStringCacheKeys'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::CloudFront::ForwardedValues | ||
| 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::ForwardedValues object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Cookies => $value, ..., QueryStringCacheKeys => $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::ForwardedValues object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Cookies | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | This field is deprecated. We recommend that you use a cache policy or | ||
| 40 | an origin request policy instead of this field. | ||
| 41 | |||
| 42 | If you want to include values in the cache key, use a cache policy. For | ||
| 43 | more information, see Creating cache policies | ||
| 44 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) | ||
| 45 | in the I<Amazon CloudFront Developer Guide>. | ||
| 46 | |||
| 47 | If you want to send values to the origin but not include them in the | ||
| 48 | cache key, use an origin request policy. For more information, see | ||
| 49 | Creating origin request policies | ||
| 50 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) | ||
| 51 | in the I<Amazon CloudFront Developer Guide>. | ||
| 52 | |||
| 53 | A complex type that specifies how CloudFront handles query strings, | ||
| 54 | cookies, and HTTP headers. | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> Cookies => L<Paws::CloudFront::CookiePreference> | ||
| 60 | |||
| 61 | This field is deprecated. We recommend that you use a cache policy or | ||
| 62 | an origin request policy instead of this field. | ||
| 63 | |||
| 64 | If you want to include cookies in the cache key, use a cache policy. | ||
| 65 | For more information, see Creating cache policies | ||
| 66 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) | ||
| 67 | in the I<Amazon CloudFront Developer Guide>. | ||
| 68 | |||
| 69 | If you want to send cookies to the origin but not include them in the | ||
| 70 | cache key, use an origin request policy. For more information, see | ||
| 71 | Creating origin request policies | ||
| 72 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) | ||
| 73 | in the I<Amazon CloudFront Developer Guide>. | ||
| 74 | |||
| 75 | A complex type that specifies whether you want CloudFront to forward | ||
| 76 | cookies to the origin and, if so, which ones. For more information | ||
| 77 | about forwarding cookies to the origin, see How CloudFront Forwards, | ||
| 78 | Caches, and Logs Cookies | ||
| 79 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) | ||
| 80 | in the I<Amazon CloudFront Developer Guide>. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Headers => L<Paws::CloudFront::Headers> | ||
| 84 | |||
| 85 | This field is deprecated. We recommend that you use a cache policy or | ||
| 86 | an origin request policy instead of this field. | ||
| 87 | |||
| 88 | If you want to include headers in the cache key, use a cache policy. | ||
| 89 | For more information, see Creating cache policies | ||
| 90 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) | ||
| 91 | in the I<Amazon CloudFront Developer Guide>. | ||
| 92 | |||
| 93 | If you want to send headers to the origin but not include them in the | ||
| 94 | cache key, use an origin request policy. For more information, see | ||
| 95 | Creating origin request policies | ||
| 96 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) | ||
| 97 | in the I<Amazon CloudFront Developer Guide>. | ||
| 98 | |||
| 99 | A complex type that specifies the C<Headers>, if any, that you want | ||
| 100 | CloudFront to forward to the origin for this cache behavior | ||
| 101 | (whitelisted headers). For the headers that you specify, CloudFront | ||
| 102 | also caches separate versions of a specified object that is based on | ||
| 103 | the header values in viewer requests. | ||
| 104 | |||
| 105 | For more information, see Caching Content Based on Request Headers | ||
| 106 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) | ||
| 107 | in the I<Amazon CloudFront Developer Guide>. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> QueryString => Bool | ||
| 111 | |||
| 112 | This field is deprecated. We recommend that you use a cache policy or | ||
| 113 | an origin request policy instead of this field. | ||
| 114 | |||
| 115 | If you want to include query strings in the cache key, use a cache | ||
| 116 | policy. For more information, see Creating cache policies | ||
| 117 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) | ||
| 118 | in the I<Amazon CloudFront Developer Guide>. | ||
| 119 | |||
| 120 | If you want to send query strings to the origin but not include them in | ||
| 121 | the cache key, use an origin request policy. For more information, see | ||
| 122 | Creating origin request policies | ||
| 123 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) | ||
| 124 | in the I<Amazon CloudFront Developer Guide>. | ||
| 125 | |||
| 126 | Indicates whether you want CloudFront to forward query strings to the | ||
| 127 | origin that is associated with this cache behavior and cache based on | ||
| 128 | the query string parameters. CloudFront behavior depends on the value | ||
| 129 | of C<QueryString> and on the values that you specify for | ||
| 130 | C<QueryStringCacheKeys>, if any: | ||
| 131 | |||
| 132 | If you specify true for C<QueryString> and you don't specify any values | ||
| 133 | for C<QueryStringCacheKeys>, CloudFront forwards all query string | ||
| 134 | parameters to the origin and caches based on all query string | ||
| 135 | parameters. Depending on how many query string parameters and values | ||
| 136 | you have, this can adversely affect performance because CloudFront must | ||
| 137 | forward more requests to the origin. | ||
| 138 | |||
| 139 | If you specify true for C<QueryString> and you specify one or more | ||
| 140 | values for C<QueryStringCacheKeys>, CloudFront forwards all query | ||
| 141 | string parameters to the origin, but it only caches based on the query | ||
| 142 | string parameters that you specify. | ||
| 143 | |||
| 144 | If you specify false for C<QueryString>, CloudFront doesn't forward any | ||
| 145 | query string parameters to the origin, and doesn't cache based on query | ||
| 146 | string parameters. | ||
| 147 | |||
| 148 | For more information, see Configuring CloudFront to Cache Based on | ||
| 149 | Query String Parameters | ||
| 150 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) | ||
| 151 | in the I<Amazon CloudFront Developer Guide>. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 QueryStringCacheKeys => L<Paws::CloudFront::QueryStringCacheKeys> | ||
| 155 | |||
| 156 | This field is deprecated. We recommend that you use a cache policy or | ||
| 157 | an origin request policy instead of this field. | ||
| 158 | |||
| 159 | If you want to include query strings in the cache key, use a cache | ||
| 160 | policy. For more information, see Creating cache policies | ||
| 161 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) | ||
| 162 | in the I<Amazon CloudFront Developer Guide>. | ||
| 163 | |||
| 164 | If you want to send query strings to the origin but not include them in | ||
| 165 | the cache key, use an origin request policy. For more information, see | ||
| 166 | Creating origin request policies | ||
| 167 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) | ||
| 168 | in the I<Amazon CloudFront Developer Guide>. | ||
| 169 | |||
| 170 | A complex type that contains information about the query string | ||
| 171 | parameters that you want CloudFront to use for caching for this cache | ||
| 172 | behavior. | ||
| 173 | |||
| 174 | |||
| 175 | |||
| 176 | =head1 SEE ALSO | ||
| 177 | |||
| 178 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 179 | |||
| 180 | =head1 BUGS and CONTRIBUTIONS | ||
| 181 | |||
| 182 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 183 | |||
| 184 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 185 | |||
| 186 | =cut | ||
| 187 |