blib/lib/Paws/CloudFront/DefaultCacheBehavior.pm untested

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::CloudFront::DefaultCacheBehavior;
3 use Moose;
4 has AllowedMethods => (is => 'ro', isa => 'Paws::CloudFront::AllowedMethods');
5 has CachePolicyId => (is => 'ro', isa => 'Str');
6 has Compress => (is => 'ro', isa => 'Bool');
7 has DefaultTTL => (is => 'ro', isa => 'Int');
8 has FieldLevelEncryptionId => (is => 'ro', isa => 'Str');
9 has ForwardedValues => (is => 'ro', isa => 'Paws::CloudFront::ForwardedValues');
10 has FunctionAssociations => (is => 'ro', isa => 'Paws::CloudFront::FunctionAssociations');
11 has LambdaFunctionAssociations => (is => 'ro', isa => 'Paws::CloudFront::LambdaFunctionAssociations');
12 has MaxTTL => (is => 'ro', isa => 'Int');
13 has MinTTL => (is => 'ro', isa => 'Int');
14 has OriginRequestPolicyId => (is => 'ro', isa => 'Str');
15 has RealtimeLogConfigArn => (is => 'ro', isa => 'Str');
16 has SmoothStreaming => (is => 'ro', isa => 'Bool');
17 has TargetOriginId => (is => 'ro', isa => 'Str', required => 1);
18 has TrustedKeyGroups => (is => 'ro', isa => 'Paws::CloudFront::TrustedKeyGroups');
19 has TrustedSigners => (is => 'ro', isa => 'Paws::CloudFront::TrustedSigners');
20 has ViewerProtocolPolicy => (is => 'ro', isa => 'Str', required => 1);
21  
22 1;
23  
24 ### main pod documentation begin ###
25  
26 =head1 NAME
27  
28 Paws::CloudFront::DefaultCacheBehavior
29  
30 =head1 USAGE
31  
32 This class represents one of two things:
33  
34 =head3 Arguments in a call to a service
35  
36 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
37 Each attribute should be used as a named argument in the calls that expect this type of object.
38  
39 As an example, if Att1 is expected to be a Paws::CloudFront::DefaultCacheBehavior object:
40  
41 $service_obj->Method(Att1 => { AllowedMethods => $value, ..., ViewerProtocolPolicy => $value });
42  
43 =head3 Results returned from an API call
44  
45 Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::DefaultCacheBehavior object:
46  
47 $result = $service_obj->Method(...);
48 $result->Att1->AllowedMethods
49  
50 =head1 DESCRIPTION
51  
52 A complex type that describes the default cache behavior if you
53 donE<rsquo>t specify a C<CacheBehavior> element or if request URLs
54 donE<rsquo>t match any of the values of C<PathPattern> in
55 C<CacheBehavior> elements. You must create exactly one default cache
56 behavior.
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 AllowedMethods => L<Paws::CloudFront::AllowedMethods>
62  
63  
64  
65  
66 =head2 CachePolicyId => Str
67  
68 The unique identifier of the cache policy that is attached to the
69 default cache behavior. For more information, see Creating cache
70 policies
71 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)
72 or Using the managed cache policies
73 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html)
74 in the I<Amazon CloudFront Developer Guide>.
75  
76 A C<DefaultCacheBehavior> must include either a C<CachePolicyId> or
77 C<ForwardedValues>. We recommend that you use a C<CachePolicyId>.
78  
79  
80 =head2 Compress => Bool
81  
82 Whether you want CloudFront to automatically compress certain files for
83 this cache behavior. If so, specify C<true>; if not, specify C<false>.
84 For more information, see Serving Compressed Files
85 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html)
86 in the I<Amazon CloudFront Developer Guide>.
87  
88  
89 =head2 DefaultTTL => Int
90  
91 This field is deprecated. We recommend that you use the C<DefaultTTL>
92 field in a cache policy instead of this field. For more information,
93 see Creating cache policies
94 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)
95 or Using the managed cache policies
96 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html)
97 in the I<Amazon CloudFront Developer Guide>.
98  
99 The default amount of time that you want objects to stay in CloudFront
100 caches before CloudFront forwards another request to your origin to
101 determine whether the object has been updated. The value that you
102 specify applies only when your origin does not add HTTP headers such as
103 C<Cache-Control max-age>, C<Cache-Control s-maxage>, and C<Expires> to
104 objects. For more information, see Managing How Long Content Stays in
105 an Edge Cache (Expiration)
106 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html)
107 in the I<Amazon CloudFront Developer Guide>.
108  
109  
110 =head2 FieldLevelEncryptionId => Str
111  
112 The value of C<ID> for the field-level encryption configuration that
113 you want CloudFront to use for encrypting specific fields of data for
114 the default cache behavior.
115  
116  
117 =head2 ForwardedValues => L<Paws::CloudFront::ForwardedValues>
118  
119 This field is deprecated. We recommend that you use a cache policy or
120 an origin request policy instead of this field. For more information,
121 see Working with policies
122 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html)
123 in the I<Amazon CloudFront Developer Guide>.
124  
125 If you want to include values in the cache key, use a cache policy. For
126 more information, see Creating cache policies
127 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)
128 or Using the managed cache policies
129 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html)
130 in the I<Amazon CloudFront Developer Guide>.
131  
132 If you want to send values to the origin but not include them in the
133 cache key, use an origin request policy. For more information, see
134 Creating origin request policies
135 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy)
136 or Using the managed origin request policies
137 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html)
138 in the I<Amazon CloudFront Developer Guide>.
139  
140 A C<DefaultCacheBehavior> must include either a C<CachePolicyId> or
141 C<ForwardedValues>. We recommend that you use a C<CachePolicyId>.
142  
143 A complex type that specifies how CloudFront handles query strings,
144 cookies, and HTTP headers.
145  
146  
147 =head2 FunctionAssociations => L<Paws::CloudFront::FunctionAssociations>
148  
149 A list of CloudFront functions that are associated with this cache
150 behavior. CloudFront functions must be published to the C<LIVE> stage
151 to associate them with a cache behavior.
152  
153  
154 =head2 LambdaFunctionAssociations => L<Paws::CloudFront::LambdaFunctionAssociations>
155  
156 A complex type that contains zero or more Lambda function associations
157 for a cache behavior.
158  
159  
160 =head2 MaxTTL => Int
161  
162 This field is deprecated. We recommend that you use the C<MaxTTL> field
163 in a cache policy instead of this field. For more information, see
164 Creating cache policies
165 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)
166 or Using the managed cache policies
167 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html)
168 in the I<Amazon CloudFront Developer Guide>.
169  
170 The maximum amount of time that you want objects to stay in CloudFront
171 caches before CloudFront forwards another request to your origin to
172 determine whether the object has been updated. The value that you
173 specify applies only when your origin adds HTTP headers such as
174 C<Cache-Control max-age>, C<Cache-Control s-maxage>, and C<Expires> to
175 objects. For more information, see Managing How Long Content Stays in
176 an Edge Cache (Expiration)
177 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html)
178 in the I<Amazon CloudFront Developer Guide>.
179  
180  
181 =head2 MinTTL => Int
182  
183 This field is deprecated. We recommend that you use the C<MinTTL> field
184 in a cache policy instead of this field. For more information, see
185 Creating cache policies
186 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)
187 or Using the managed cache policies
188 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html)
189 in the I<Amazon CloudFront Developer Guide>.
190  
191 The minimum amount of time that you want objects to stay in CloudFront
192 caches before CloudFront forwards another request to your origin to
193 determine whether the object has been updated. For more information,
194 see Managing How Long Content Stays in an Edge Cache (Expiration)
195 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html)
196 in the I<Amazon CloudFront Developer Guide>.
197  
198 You must specify C<0> for C<MinTTL> if you configure CloudFront to
199 forward all headers to your origin (under C<Headers>, if you specify
200 C<1> for C<Quantity> and C<*> for C<Name>).
201  
202  
203 =head2 OriginRequestPolicyId => Str
204  
205 The unique identifier of the origin request policy that is attached to
206 the default cache behavior. For more information, see Creating origin
207 request policies
208 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy)
209 or Using the managed origin request policies
210 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html)
211 in the I<Amazon CloudFront Developer Guide>.
212  
213  
214 =head2 RealtimeLogConfigArn => Str
215  
216 The Amazon Resource Name (ARN) of the real-time log configuration that
217 is attached to this cache behavior. For more information, see Real-time
218 logs
219 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html)
220 in the I<Amazon CloudFront Developer Guide>.
221  
222  
223 =head2 SmoothStreaming => Bool
224  
225 Indicates whether you want to distribute media files in the Microsoft
226 Smooth Streaming format using the origin that is associated with this
227 cache behavior. If so, specify C<true>; if not, specify C<false>. If
228 you specify C<true> for C<SmoothStreaming>, you can still distribute
229 other content using this cache behavior if the content matches the
230 value of C<PathPattern>.
231  
232  
233 =head2 B<REQUIRED> TargetOriginId => Str
234  
235 The value of C<ID> for the origin that you want CloudFront to route
236 requests to when they use the default cache behavior.
237  
238  
239 =head2 TrustedKeyGroups => L<Paws::CloudFront::TrustedKeyGroups>
240  
241 A list of key groups that CloudFront can use to validate signed URLs or
242 signed cookies.
243  
244 When a cache behavior contains trusted key groups, CloudFront requires
245 signed URLs or signed cookies for all requests that match the cache
246 behavior. The URLs or cookies must be signed with a private key whose
247 corresponding public key is in the key group. The signed URL or cookie
248 contains information about which public key CloudFront should use to
249 verify the signature. For more information, see Serving private content
250 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html)
251 in the I<Amazon CloudFront Developer Guide>.
252  
253  
254 =head2 TrustedSigners => L<Paws::CloudFront::TrustedSigners>
255  
256 We recommend using C<TrustedKeyGroups> instead of C<TrustedSigners>.
257  
258 A list of AWS account IDs whose public keys CloudFront can use to
259 validate signed URLs or signed cookies.
260  
261 When a cache behavior contains trusted signers, CloudFront requires
262 signed URLs or signed cookies for all requests that match the cache
263 behavior. The URLs or cookies must be signed with the private key of a
264 CloudFront key pair in a trusted signerE<rsquo>s AWS account. The
265 signed URL or cookie contains information about which public key
266 CloudFront should use to verify the signature. For more information,
267 see Serving private content
268 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html)
269 in the I<Amazon CloudFront Developer Guide>.
270  
271  
272 =head2 B<REQUIRED> ViewerProtocolPolicy => Str
273  
274 The protocol that viewers can use to access the files in the origin
275 specified by C<TargetOriginId> when a request matches the path pattern
276 in C<PathPattern>. You can specify the following options:
277  
278 =over
279  
280 =item *
281  
282 C<allow-all>: Viewers can use HTTP or HTTPS.
283  
284 =item *
285  
286 C<redirect-to-https>: If a viewer submits an HTTP request, CloudFront
287 returns an HTTP status code of 301 (Moved Permanently) to the viewer
288 along with the HTTPS URL. The viewer then resubmits the request using
289 the new URL.
290  
291 =item *
292  
293 C<https-only>: If a viewer sends an HTTP request, CloudFront returns an
294 HTTP status code of 403 (Forbidden).
295  
296 =back
297  
298 For more information about requiring the HTTPS protocol, see Requiring
299 HTTPS Between Viewers and CloudFront
300 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html)
301 in the I<Amazon CloudFront Developer Guide>.
302  
303 The only way to guarantee that viewers retrieve an object that was
304 fetched from the origin using HTTPS is never to use any other protocol
305 to fetch the object. If you have recently changed from HTTP to HTTPS,
306 we recommend that you clear your objectsE<rsquo> cache because cached
307 objects are protocol agnostic. That means that an edge location will
308 return an object from the cache regardless of whether the current
309 request protocol matches the protocol used previously. For more
310 information, see Managing Cache Expiration
311 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html)
312 in the I<Amazon CloudFront Developer Guide>.
313  
314  
315  
316 =head1 SEE ALSO
317  
318 This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront>
319  
320 =head1 BUGS and CONTRIBUTIONS
321  
322 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
323  
324 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
325  
326 =cut
327