blib/lib/Paws/CloudFront/DistributionConfig.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::DistributionConfig;
3 use Moose;
4 has Aliases => (is => 'ro', isa => 'Paws::CloudFront::Aliases');
5 has CacheBehaviors => (is => 'ro', isa => 'Paws::CloudFront::CacheBehaviors');
6 has CallerReference => (is => 'ro', isa => 'Str', required => 1);
7 has Comment => (is => 'ro', isa => 'Str', required => 1);
8 has CustomErrorResponses => (is => 'ro', isa => 'Paws::CloudFront::CustomErrorResponses');
9 has DefaultCacheBehavior => (is => 'ro', isa => 'Paws::CloudFront::DefaultCacheBehavior', required => 1);
10 has DefaultRootObject => (is => 'ro', isa => 'Str');
11 has Enabled => (is => 'ro', isa => 'Bool', required => 1);
12 has HttpVersion => (is => 'ro', isa => 'Str');
13 has IsIPV6Enabled => (is => 'ro', isa => 'Bool');
14 has Logging => (is => 'ro', isa => 'Paws::CloudFront::LoggingConfig');
15 has OriginGroups => (is => 'ro', isa => 'Paws::CloudFront::OriginGroups');
16 has Origins => (is => 'ro', isa => 'Paws::CloudFront::Origins', required => 1);
17 has PriceClass => (is => 'ro', isa => 'Str');
18 has Restrictions => (is => 'ro', isa => 'Paws::CloudFront::Restrictions');
19 has ViewerCertificate => (is => 'ro', isa => 'Paws::CloudFront::ViewerCertificate');
20 has WebACLId => (is => 'ro', isa => 'Str');
21  
22 1;
23  
24 ### main pod documentation begin ###
25  
26 =head1 NAME
27  
28 Paws::CloudFront::DistributionConfig
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::DistributionConfig object:
40  
41 $service_obj->Method(Att1 => { Aliases => $value, ..., WebACLId => $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::DistributionConfig object:
46  
47 $result = $service_obj->Method(...);
48 $result->Att1->Aliases
49  
50 =head1 DESCRIPTION
51  
52 A distribution configuration.
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 Aliases => L<Paws::CloudFront::Aliases>
58  
59 A complex type that contains information about CNAMEs (alternate domain
60 names), if any, for this distribution.
61  
62  
63 =head2 CacheBehaviors => L<Paws::CloudFront::CacheBehaviors>
64  
65 A complex type that contains zero or more C<CacheBehavior> elements.
66  
67  
68 =head2 B<REQUIRED> CallerReference => Str
69  
70 A unique value (for example, a date-time stamp) that ensures that the
71 request can't be replayed.
72  
73 If the value of C<CallerReference> is new (regardless of the content of
74 the C<DistributionConfig> object), CloudFront creates a new
75 distribution.
76  
77 If C<CallerReference> is a value that you already sent in a previous
78 request to create a distribution, CloudFront returns a
79 C<DistributionAlreadyExists> error.
80  
81  
82 =head2 B<REQUIRED> Comment => Str
83  
84 An optional comment to describe the distribution. The comment cannot be
85 longer than 128 characters.
86  
87  
88 =head2 CustomErrorResponses => L<Paws::CloudFront::CustomErrorResponses>
89  
90 A complex type that controls the following:
91  
92 =over
93  
94 =item *
95  
96 Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range
97 with custom error messages before returning the response to the viewer.
98  
99 =item *
100  
101 How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
102  
103 =back
104  
105 For more information about custom error pages, see Customizing Error
106 Responses
107 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html)
108 in the I<Amazon CloudFront Developer Guide>.
109  
110  
111 =head2 B<REQUIRED> DefaultCacheBehavior => L<Paws::CloudFront::DefaultCacheBehavior>
112  
113 A complex type that describes the default cache behavior if you don't
114 specify a C<CacheBehavior> element or if files don't match any of the
115 values of C<PathPattern> in C<CacheBehavior> elements. You must create
116 exactly one default cache behavior.
117  
118  
119 =head2 DefaultRootObject => Str
120  
121 The object that you want CloudFront to request from your origin (for
122 example, C<index.html>) when a viewer requests the root URL for your
123 distribution (C<http://www.example.com>) instead of an object in your
124 distribution (C<http://www.example.com/product-description.html>).
125 Specifying a default root object avoids exposing the contents of your
126 distribution.
127  
128 Specify only the object name, for example, C<index.html>. Don't add a
129 C</> before the object name.
130  
131 If you don't want to specify a default root object when you create a
132 distribution, include an empty C<DefaultRootObject> element.
133  
134 To delete the default root object from an existing distribution, update
135 the distribution configuration and include an empty
136 C<DefaultRootObject> element.
137  
138 To replace the default root object, update the distribution
139 configuration and specify the new object.
140  
141 For more information about the default root object, see Creating a
142 Default Root Object
143 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html)
144 in the I<Amazon CloudFront Developer Guide>.
145  
146  
147 =head2 B<REQUIRED> Enabled => Bool
148  
149 From this field, you can enable or disable the selected distribution.
150  
151  
152 =head2 HttpVersion => Str
153  
154 (Optional) Specify the maximum HTTP version that you want viewers to
155 use to communicate with CloudFront. The default value for new web
156 distributions is http2. Viewers that don't support HTTP/2 automatically
157 use an earlier HTTP version.
158  
159 For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2
160 or later, and must support Server Name Identification (SNI).
161  
162 In general, configuring CloudFront to communicate with viewers using
163 HTTP/2 reduces latency. You can improve performance by optimizing for
164 HTTP/2. For more information, do an Internet search for "http/2
165 optimization."
166  
167  
168 =head2 IsIPV6Enabled => Bool
169  
170 If you want CloudFront to respond to IPv6 DNS requests with an IPv6
171 address for your distribution, specify C<true>. If you specify
172 C<false>, CloudFront responds to IPv6 DNS requests with the DNS
173 response code C<NOERROR> and with no IP addresses. This allows viewers
174 to submit a second request, for an IPv4 address for your distribution.
175  
176 In general, you should enable IPv6 if you have users on IPv6 networks
177 who want to access your content. However, if you're using signed URLs
178 or signed cookies to restrict access to your content, and if you're
179 using a custom policy that includes the C<IpAddress> parameter to
180 restrict the IP addresses that can access your content, don't enable
181 IPv6. If you want to restrict access to some content by IP address and
182 not restrict access to other content (or restrict access but not by IP
183 address), you can create two distributions. For more information, see
184 Creating a Signed URL Using a Custom Policy
185 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html)
186 in the I<Amazon CloudFront Developer Guide>.
187  
188 If you're using an Amazon Route 53 alias resource record set to route
189 traffic to your CloudFront distribution, you need to create a second
190 alias resource record set when both of the following are true:
191  
192 =over
193  
194 =item *
195  
196 You enable IPv6 for the distribution
197  
198 =item *
199  
200 You're using alternate domain names in the URLs for your objects
201  
202 =back
203  
204 For more information, see Routing Traffic to an Amazon CloudFront Web
205 Distribution by Using Your Domain Name
206 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html)
207 in the I<Amazon Route 53 Developer Guide>.
208  
209 If you created a CNAME resource record set, either with Amazon Route 53
210 or with another DNS service, you don't need to make any changes. A
211 CNAME record will route traffic to your distribution regardless of the
212 IP address format of the viewer request.
213  
214  
215 =head2 Logging => L<Paws::CloudFront::LoggingConfig>
216  
217 A complex type that controls whether access logs are written for the
218 distribution.
219  
220 For more information about logging, see Access Logs
221 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html)
222 in the I<Amazon CloudFront Developer Guide>.
223  
224  
225 =head2 OriginGroups => L<Paws::CloudFront::OriginGroups>
226  
227 A complex type that contains information about origin groups for this
228 distribution.
229  
230  
231 =head2 B<REQUIRED> Origins => L<Paws::CloudFront::Origins>
232  
233 A complex type that contains information about origins for this
234 distribution.
235  
236  
237 =head2 PriceClass => Str
238  
239 The price class that corresponds with the maximum price that you want
240 to pay for CloudFront service. If you specify C<PriceClass_All>,
241 CloudFront responds to requests for your objects from all CloudFront
242 edge locations.
243  
244 If you specify a price class other than C<PriceClass_All>, CloudFront
245 serves your objects from the CloudFront edge location that has the
246 lowest latency among the edge locations in your price class. Viewers
247 who are in or near regions that are excluded from your specified price
248 class may encounter slower performance.
249  
250 For more information about price classes, see Choosing the Price Class
251 for a CloudFront Distribution
252 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html)
253 in the I<Amazon CloudFront Developer Guide>. For information about
254 CloudFront pricing, including how price classes (such as Price Class
255 100) map to CloudFront regions, see Amazon CloudFront Pricing
256 (http://aws.amazon.com/cloudfront/pricing/).
257  
258  
259 =head2 Restrictions => L<Paws::CloudFront::Restrictions>
260  
261 A complex type that identifies ways in which you want to restrict
262 distribution of your content.
263  
264  
265 =head2 ViewerCertificate => L<Paws::CloudFront::ViewerCertificate>
266  
267 A complex type that determines the distributionE<rsquo>s SSL/TLS
268 configuration for communicating with viewers.
269  
270  
271 =head2 WebACLId => Str
272  
273 A unique identifier that specifies the AWS WAF web ACL, if any, to
274 associate with this distribution. To specify a web ACL created using
275 the latest version of AWS WAF, use the ACL ARN, for example
276 C<arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a>.
277 To specify a web ACL created using AWS WAF Classic, use the ACL ID, for
278 example C<473e64fd-f30b-4765-81a0-62ad96dd167a>.
279  
280 AWS WAF is a web application firewall that lets you monitor the HTTP
281 and HTTPS requests that are forwarded to CloudFront, and lets you
282 control access to your content. Based on conditions that you specify,
283 such as the IP addresses that requests originate from or the values of
284 query strings, CloudFront responds to requests either with the
285 requested content or with an HTTP 403 status code (Forbidden). You can
286 also configure CloudFront to return a custom error page when a request
287 is blocked. For more information about AWS WAF, see the AWS WAF
288 Developer Guide
289 (https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).
290  
291  
292  
293 =head1 SEE ALSO
294  
295 This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront>
296  
297 =head1 BUGS and CONTRIBUTIONS
298  
299 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
300  
301 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
302  
303 =cut
304