« blib/lib/Paws/CloudFront/CustomHeaders.pm
↑ Summary
blib/lib/Paws/CloudFront/DefaultCacheBehavior.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::CustomOriginConfig; | ||
| 3 | use Moose; | ||
| 4 | has HTTPPort => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has HTTPSPort => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has OriginKeepaliveTimeout => (is => 'ro', isa => 'Int'); | ||
| 7 | has OriginProtocolPolicy => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has OriginReadTimeout => (is => 'ro', isa => 'Int'); | ||
| 9 | has OriginSslProtocols => (is => 'ro', isa => 'Paws::CloudFront::OriginSslProtocols'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CloudFront::CustomOriginConfig | ||
| 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::CustomOriginConfig object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { HTTPPort => $value, ..., OriginSslProtocols => $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::CustomOriginConfig object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->HTTPPort | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | A custom origin. A custom origin is any origin that is I<not> an Amazon | ||
| 42 | S3 bucket, with one exception. An Amazon S3 bucket that is configured | ||
| 43 | with static website hosting | ||
| 44 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) | ||
| 45 | I<is> a custom origin. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> HTTPPort => Int | ||
| 51 | |||
| 52 | The HTTP port that CloudFront uses to connect to the origin. Specify | ||
| 53 | the HTTP port that the origin listens on. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> HTTPSPort => Int | ||
| 57 | |||
| 58 | The HTTPS port that CloudFront uses to connect to the origin. Specify | ||
| 59 | the HTTPS port that the origin listens on. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 OriginKeepaliveTimeout => Int | ||
| 63 | |||
| 64 | Specifies how long, in seconds, CloudFront persists its connection to | ||
| 65 | the origin. The minimum timeout is 1 second, the maximum is 60 seconds, | ||
| 66 | and the default (if you donE<rsquo>t specify otherwise) is 5 seconds. | ||
| 67 | |||
| 68 | For more information, see Origin Keep-alive Timeout | ||
| 69 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) | ||
| 70 | in the I<Amazon CloudFront Developer Guide>. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> OriginProtocolPolicy => Str | ||
| 74 | |||
| 75 | Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect | ||
| 76 | to the origin. Valid values are: | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<http-only> E<ndash> CloudFront always uses HTTP to connect to the | ||
| 83 | origin. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<match-viewer> E<ndash> CloudFront connects to the origin using the | ||
| 88 | same protocol that the viewer used to connect to CloudFront. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<https-only> E<ndash> CloudFront always uses HTTPS to connect to the | ||
| 93 | origin. | ||
| 94 | |||
| 95 | =back | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 OriginReadTimeout => Int | ||
| 100 | |||
| 101 | Specifies how long, in seconds, CloudFront waits for a response from | ||
| 102 | the origin. This is also known as the I<origin response timeout>. The | ||
| 103 | minimum timeout is 1 second, the maximum is 60 seconds, and the default | ||
| 104 | (if you donE<rsquo>t specify otherwise) is 30 seconds. | ||
| 105 | |||
| 106 | For more information, see Origin Response Timeout | ||
| 107 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) | ||
| 108 | in the I<Amazon CloudFront Developer Guide>. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 OriginSslProtocols => L<Paws::CloudFront::OriginSslProtocols> | ||
| 112 | |||
| 113 | Specifies the minimum SSL/TLS protocol that CloudFront uses when | ||
| 114 | connecting to your origin over HTTPS. Valid values include C<SSLv3>, | ||
| 115 | C<TLSv1>, C<TLSv1.1>, and C<TLSv1.2>. | ||
| 116 | |||
| 117 | For more information, see Minimum Origin SSL Protocol | ||
| 118 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) | ||
| 119 | in the I<Amazon CloudFront Developer Guide>. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |