« blib/lib/Paws/Lightsail/CacheBehaviorPerPath.pm
↑ Summary
blib/lib/Paws/Lightsail/Certificate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::CacheSettings; | ||
| 3 | use Moose; | ||
| 4 | has AllowedHTTPMethods => (is => 'ro', isa => 'Str', request_name => 'allowedHTTPMethods', traits => ['NameInRequest']); | ||
| 5 | has CachedHTTPMethods => (is => 'ro', isa => 'Str', request_name => 'cachedHTTPMethods', traits => ['NameInRequest']); | ||
| 6 | has DefaultTTL => (is => 'ro', isa => 'Int', request_name => 'defaultTTL', traits => ['NameInRequest']); | ||
| 7 | has ForwardedCookies => (is => 'ro', isa => 'Paws::Lightsail::CookieObject', request_name => 'forwardedCookies', traits => ['NameInRequest']); | ||
| 8 | has ForwardedHeaders => (is => 'ro', isa => 'Paws::Lightsail::HeaderObject', request_name => 'forwardedHeaders', traits => ['NameInRequest']); | ||
| 9 | has ForwardedQueryStrings => (is => 'ro', isa => 'Paws::Lightsail::QueryStringObject', request_name => 'forwardedQueryStrings', traits => ['NameInRequest']); | ||
| 10 | has MaximumTTL => (is => 'ro', isa => 'Int', request_name => 'maximumTTL', traits => ['NameInRequest']); | ||
| 11 | has MinimumTTL => (is => 'ro', isa => 'Int', request_name => 'minimumTTL', traits => ['NameInRequest']); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Lightsail::CacheSettings | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::Lightsail::CacheSettings object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { AllowedHTTPMethods => $value, ..., MinimumTTL => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::CacheSettings object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->AllowedHTTPMethods | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Describes the cache settings of an Amazon Lightsail content delivery | ||
| 44 | network (CDN) distribution. | ||
| 45 | |||
| 46 | These settings apply only to your distribution's C<cacheBehaviors> | ||
| 47 | (including the C<defaultCacheBehavior>) that have a C<behavior> of | ||
| 48 | C<cache>. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 AllowedHTTPMethods => Str | ||
| 54 | |||
| 55 | The HTTP methods that are processed and forwarded to the distribution's | ||
| 56 | origin. | ||
| 57 | |||
| 58 | You can specify the following options: | ||
| 59 | |||
| 60 | =over | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | C<GET,HEAD> - The distribution forwards the C<GET> and C<HEAD> methods. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<GET,HEAD,OPTIONS> - The distribution forwards the C<GET>, C<HEAD>, | ||
| 69 | and C<OPTIONS> methods. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE> - The distribution forwards | ||
| 74 | the C<GET>, C<HEAD>, C<OPTIONS>, C<PUT>, C<PATCH>, C<POST>, and | ||
| 75 | C<DELETE> methods. | ||
| 76 | |||
| 77 | =back | ||
| 78 | |||
| 79 | If you specify the third option, you might need to restrict access to | ||
| 80 | your distribution's origin so users can't perform operations that you | ||
| 81 | don't want them to. For example, you might not want users to have | ||
| 82 | permission to delete objects from your origin. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 CachedHTTPMethods => Str | ||
| 86 | |||
| 87 | The HTTP method responses that are cached by your distribution. | ||
| 88 | |||
| 89 | You can specify the following options: | ||
| 90 | |||
| 91 | =over | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<GET,HEAD> - The distribution caches responses to the C<GET> and | ||
| 96 | C<HEAD> methods. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<GET,HEAD,OPTIONS> - The distribution caches responses to the C<GET>, | ||
| 101 | C<HEAD>, and C<OPTIONS> methods. | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 DefaultTTL => Int | ||
| 108 | |||
| 109 | The default amount of time that objects stay in the distribution's | ||
| 110 | cache before the distribution forwards another request to the origin to | ||
| 111 | determine whether the content has been updated. | ||
| 112 | |||
| 113 | The value specified applies only when the origin does not add HTTP | ||
| 114 | headers such as C<Cache-Control max-age>, C<Cache-Control s-maxage>, | ||
| 115 | and C<Expires> to objects. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 ForwardedCookies => L<Paws::Lightsail::CookieObject> | ||
| 119 | |||
| 120 | An object that describes the cookies that are forwarded to the origin. | ||
| 121 | Your content is cached based on the cookies that are forwarded. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 ForwardedHeaders => L<Paws::Lightsail::HeaderObject> | ||
| 125 | |||
| 126 | An object that describes the headers that are forwarded to the origin. | ||
| 127 | Your content is cached based on the headers that are forwarded. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 ForwardedQueryStrings => L<Paws::Lightsail::QueryStringObject> | ||
| 131 | |||
| 132 | An object that describes the query strings that are forwarded to the | ||
| 133 | origin. Your content is cached based on the query strings that are | ||
| 134 | forwarded. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 MaximumTTL => Int | ||
| 138 | |||
| 139 | The maximum amount of time that objects stay in the distribution's | ||
| 140 | cache before the distribution forwards another request to the origin to | ||
| 141 | determine whether the object has been updated. | ||
| 142 | |||
| 143 | The value specified applies only when the origin adds HTTP headers such | ||
| 144 | as C<Cache-Control max-age>, C<Cache-Control s-maxage>, and C<Expires> | ||
| 145 | to objects. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 MinimumTTL => Int | ||
| 149 | |||
| 150 | The minimum amount of time that objects stay in the distribution's | ||
| 151 | cache before the distribution forwards another request to the origin to | ||
| 152 | determine whether the object has been updated. | ||
| 153 | |||
| 154 | A value of C<0> must be specified for C<minimumTTL> if the distribution | ||
| 155 | is configured to forward all headers to the origin. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head1 SEE ALSO | ||
| 160 | |||
| 161 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 162 | |||
| 163 | =head1 BUGS and CONTRIBUTIONS | ||
| 164 | |||
| 165 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 166 | |||
| 167 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 168 | |||
| 169 | =cut | ||
| 170 |