« blib/lib/Paws/CloudFront/CacheBehaviors.pm
↑ Summary
blib/lib/Paws/CloudFront/CachePolicyConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::CachePolicy; | ||
| 3 | use Moose; | ||
| 4 | has CachePolicyConfig => (is => 'ro', isa => 'Paws::CloudFront::CachePolicyConfig', required => 1); | ||
| 5 | has Id => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has LastModifiedTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::CloudFront::CachePolicy | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::CloudFront::CachePolicy object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { CachePolicyConfig => $value, ..., LastModifiedTime => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::CachePolicy object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->CachePolicyConfig | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | A cache policy. | ||
| 39 | |||
| 40 | When itE<rsquo>s attached to a cache behavior, the cache policy | ||
| 41 | determines the following: | ||
| 42 | |||
| 43 | =over | ||
| 44 | |||
| 45 | =item * | ||
| 46 | |||
| 47 | The values that CloudFront includes in the cache key. These values can | ||
| 48 | include HTTP headers, cookies, and URL query strings. CloudFront uses | ||
| 49 | the cache key to find an object in its cache that it can return to the | ||
| 50 | viewer. | ||
| 51 | |||
| 52 | =item * | ||
| 53 | |||
| 54 | The default, minimum, and maximum time to live (TTL) values that you | ||
| 55 | want objects to stay in the CloudFront cache. | ||
| 56 | |||
| 57 | =back | ||
| 58 | |||
| 59 | The headers, cookies, and query strings that are included in the cache | ||
| 60 | key are automatically included in requests that CloudFront sends to the | ||
| 61 | origin. CloudFront sends a request when it canE<rsquo>t find a valid | ||
| 62 | object in its cache that matches the requestE<rsquo>s cache key. If you | ||
| 63 | want to send values to the origin but I<not> include them in the cache | ||
| 64 | key, use C<OriginRequestPolicy>. | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> CachePolicyConfig => L<Paws::CloudFront::CachePolicyConfig> | ||
| 70 | |||
| 71 | The cache policy configuration. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> Id => Str | ||
| 75 | |||
| 76 | The unique identifier for the cache policy. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> LastModifiedTime => Str | ||
| 80 | |||
| 81 | The date and time when the cache policy was last modified. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |