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