« blib/lib/Paws/CloudFront/CachePolicy.pm
↑ Summary
blib/lib/Paws/CloudFront/CachePolicyCookiesConfig.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::CachePolicyConfig; | ||
| 3 | use Moose; | ||
| 4 | has Comment => (is => 'ro', isa => 'Str'); | ||
| 5 | has DefaultTTL => (is => 'ro', isa => 'Int'); | ||
| 6 | has MaxTTL => (is => 'ro', isa => 'Int'); | ||
| 7 | has MinTTL => (is => 'ro', isa => 'Int', required => 1); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ParametersInCacheKeyAndForwardedToOrigin => (is => 'ro', isa => 'Paws::CloudFront::ParametersInCacheKeyAndForwardedToOrigin'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CloudFront::CachePolicyConfig | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CloudFront::CachePolicyConfig object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Comment => $value, ..., ParametersInCacheKeyAndForwardedToOrigin => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::CachePolicyConfig object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Comment | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | A cache policy configuration. | ||
| 42 | |||
| 43 | This configuration determines the following: | ||
| 44 | |||
| 45 | =over | ||
| 46 | |||
| 47 | =item * | ||
| 48 | |||
| 49 | The values that CloudFront includes in the cache key. These values can | ||
| 50 | include HTTP headers, cookies, and URL query strings. CloudFront uses | ||
| 51 | the cache key to find an object in its cache that it can return to the | ||
| 52 | viewer. | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | The default, minimum, and maximum time to live (TTL) values that you | ||
| 57 | want objects to stay in the CloudFront cache. | ||
| 58 | |||
| 59 | =back | ||
| 60 | |||
| 61 | The headers, cookies, and query strings that are included in the cache | ||
| 62 | key are automatically included in requests that CloudFront sends to the | ||
| 63 | origin. CloudFront sends a request when it canE<rsquo>t find a valid | ||
| 64 | object in its cache that matches the requestE<rsquo>s cache key. If you | ||
| 65 | want to send values to the origin but I<not> include them in the cache | ||
| 66 | key, use C<OriginRequestPolicy>. | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Comment => Str | ||
| 72 | |||
| 73 | A comment to describe the cache policy. The comment cannot be longer | ||
| 74 | than 128 characters. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 DefaultTTL => Int | ||
| 78 | |||
| 79 | The default amount of time, in seconds, that you want objects to stay | ||
| 80 | in the CloudFront cache before CloudFront sends another request to the | ||
| 81 | origin to see if the object has been updated. CloudFront uses this | ||
| 82 | value as the objectE<rsquo>s time to live (TTL) only when the origin | ||
| 83 | does I<not> send C<Cache-Control> or C<Expires> headers with the | ||
| 84 | object. For more information, see Managing How Long Content Stays in an | ||
| 85 | Edge Cache (Expiration) | ||
| 86 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) | ||
| 87 | in the I<Amazon CloudFront Developer Guide>. | ||
| 88 | |||
| 89 | The default value for this field is 86400 seconds (one day). If the | ||
| 90 | value of C<MinTTL> is more than 86400 seconds, then the default value | ||
| 91 | for this field is the same as the value of C<MinTTL>. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 MaxTTL => Int | ||
| 95 | |||
| 96 | The maximum amount of time, in seconds, that objects stay in the | ||
| 97 | CloudFront cache before CloudFront sends another request to the origin | ||
| 98 | to see if the object has been updated. CloudFront uses this value only | ||
| 99 | when the origin sends C<Cache-Control> or C<Expires> headers with the | ||
| 100 | object. For more information, see Managing How Long Content Stays in an | ||
| 101 | Edge Cache (Expiration) | ||
| 102 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) | ||
| 103 | in the I<Amazon CloudFront Developer Guide>. | ||
| 104 | |||
| 105 | The default value for this field is 31536000 seconds (one year). If the | ||
| 106 | value of C<MinTTL> or C<DefaultTTL> is more than 31536000 seconds, then | ||
| 107 | the default value for this field is the same as the value of | ||
| 108 | C<DefaultTTL>. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> MinTTL => Int | ||
| 112 | |||
| 113 | The minimum amount of time, in seconds, that you want objects to stay | ||
| 114 | in the CloudFront cache before CloudFront sends another request to the | ||
| 115 | origin to see if the object has been updated. For more information, see | ||
| 116 | Managing How Long Content Stays in an Edge Cache (Expiration) | ||
| 117 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) | ||
| 118 | in the I<Amazon CloudFront Developer Guide>. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> Name => Str | ||
| 122 | |||
| 123 | A unique name to identify the cache policy. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 ParametersInCacheKeyAndForwardedToOrigin => L<Paws::CloudFront::ParametersInCacheKeyAndForwardedToOrigin> | ||
| 127 | |||
| 128 | The HTTP headers, cookies, and URL query strings to include in the | ||
| 129 | cache key. The values included in the cache key are automatically | ||
| 130 | included in requests that CloudFront sends to the origin. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |