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

filter: Statementstmt 0.0% 0 / 12 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 13 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::Origin;
3 use Moose;
4 has ConnectionAttempts => (is => 'ro', isa => 'Int');
5 has ConnectionTimeout => (is => 'ro', isa => 'Int');
6 has CustomHeaders => (is => 'ro', isa => 'Paws::CloudFront::CustomHeaders');
7 has CustomOriginConfig => (is => 'ro', isa => 'Paws::CloudFront::CustomOriginConfig');
8 has DomainName => (is => 'ro', isa => 'Str', required => 1);
9 has Id => (is => 'ro', isa => 'Str', required => 1);
10 has OriginPath => (is => 'ro', isa => 'Str');
11 has OriginShield => (is => 'ro', isa => 'Paws::CloudFront::OriginShield');
12 has S3OriginConfig => (is => 'ro', isa => 'Paws::CloudFront::S3OriginConfig');
13  
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::CloudFront::Origin
21  
22 =head1 USAGE
23  
24 This class represents one of two things:
25  
26 =head3 Arguments in a call to a service
27  
28 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29 Each attribute should be used as a named argument in the calls that expect this type of object.
30  
31 As an example, if Att1 is expected to be a Paws::CloudFront::Origin object:
32  
33 $service_obj->Method(Att1 => { ConnectionAttempts => $value, ..., S3OriginConfig => $value });
34  
35 =head3 Results returned from an API call
36  
37 Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::Origin object:
38  
39 $result = $service_obj->Method(...);
40 $result->Att1->ConnectionAttempts
41  
42 =head1 DESCRIPTION
43  
44 An origin.
45  
46 An origin is the location where content is stored, and from which
47 CloudFront gets content to serve to viewers. To specify an origin:
48  
49 =over
50  
51 =item *
52  
53 Use C<S3OriginConfig> to specify an Amazon S3 bucket that is not
54 configured with static website hosting.
55  
56 =item *
57  
58 Use C<CustomOriginConfig> to specify all other kinds of origins,
59 including:
60  
61 =over
62  
63 =item *
64  
65 An Amazon S3 bucket that is configured with static website hosting
66  
67 =item *
68  
69 An Elastic Load Balancing load balancer
70  
71 =item *
72  
73 An AWS Elemental MediaPackage endpoint
74  
75 =item *
76  
77 An AWS Elemental MediaStore container
78  
79 =item *
80  
81 Any other HTTP server, running on an Amazon EC2 instance or any other
82 kind of host
83  
84 =back
85  
86 =back
87  
88 For the current maximum number of origins that you can specify per
89 distribution, see General Quotas on Web Distributions
90 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions)
91 in the I<Amazon CloudFront Developer Guide> (quotas were formerly
92 referred to as limits).
93  
94 =head1 ATTRIBUTES
95  
96  
97 =head2 ConnectionAttempts => Int
98  
99 The number of times that CloudFront attempts to connect to the origin.
100 The minimum number is 1, the maximum is 3, and the default (if you
101 donE<rsquo>t specify otherwise) is 3.
102  
103 For a custom origin (including an Amazon S3 bucket thatE<rsquo>s
104 configured with static website hosting), this value also specifies the
105 number of times that CloudFront attempts to get a response from the
106 origin, in the case of an Origin Response Timeout
107 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout).
108  
109 For more information, see Origin Connection Attempts
110 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts)
111 in the I<Amazon CloudFront Developer Guide>.
112  
113  
114 =head2 ConnectionTimeout => Int
115  
116 The number of seconds that CloudFront waits when trying to establish a
117 connection to the origin. The minimum timeout is 1 second, the maximum
118 is 10 seconds, and the default (if you donE<rsquo>t specify otherwise)
119 is 10 seconds.
120  
121 For more information, see Origin Connection Timeout
122 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout)
123 in the I<Amazon CloudFront Developer Guide>.
124  
125  
126 =head2 CustomHeaders => L<Paws::CloudFront::CustomHeaders>
127  
128 A list of HTTP header names and values that CloudFront adds to the
129 requests that it sends to the origin.
130  
131 For more information, see Adding Custom Headers to Origin Requests
132 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html)
133 in the I<Amazon CloudFront Developer Guide>.
134  
135  
136 =head2 CustomOriginConfig => L<Paws::CloudFront::CustomOriginConfig>
137  
138 Use this type to specify an origin that is not an Amazon S3 bucket,
139 with one exception. If the Amazon S3 bucket is configured with static
140 website hosting, use this type. If the Amazon S3 bucket is not
141 configured with static website hosting, use the C<S3OriginConfig> type
142 instead.
143  
144  
145 =head2 B<REQUIRED> DomainName => Str
146  
147 The domain name for the origin.
148  
149 For more information, see Origin Domain Name
150 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName)
151 in the I<Amazon CloudFront Developer Guide>.
152  
153  
154 =head2 B<REQUIRED> Id => Str
155  
156 A unique identifier for the origin. This value must be unique within
157 the distribution.
158  
159 Use this value to specify the C<TargetOriginId> in a C<CacheBehavior>
160 or C<DefaultCacheBehavior>.
161  
162  
163 =head2 OriginPath => Str
164  
165 An optional path that CloudFront appends to the origin domain name when
166 CloudFront requests content from the origin.
167  
168 For more information, see Origin Path
169 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath)
170 in the I<Amazon CloudFront Developer Guide>.
171  
172  
173 =head2 OriginShield => L<Paws::CloudFront::OriginShield>
174  
175 CloudFront Origin Shield. Using Origin Shield can help reduce the load
176 on your origin.
177  
178 For more information, see Using Origin Shield
179 (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html)
180 in the I<Amazon CloudFront Developer Guide>.
181  
182  
183 =head2 S3OriginConfig => L<Paws::CloudFront::S3OriginConfig>
184  
185 Use this type to specify an origin that is an Amazon S3 bucket that is
186 not configured with static website hosting. To specify any other type
187 of origin, including an Amazon S3 bucket that is configured with static
188 website hosting, use the C<CustomOriginConfig> type instead.
189  
190  
191  
192 =head1 SEE ALSO
193  
194 This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront>
195  
196 =head1 BUGS and CONTRIBUTIONS
197  
198 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
199  
200 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
201  
202 =cut
203