« blib/lib/Paws/Lightsail/GetStaticIpsResult.pm
↑ Summary
blib/lib/Paws/Lightsail/HostKeyAttributes.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::HeaderObject; | ||
| 3 | use Moose; | ||
| 4 | has HeadersAllowList => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'headersAllowList', traits => ['NameInRequest']); | ||
| 5 | has Option => (is => 'ro', isa => 'Str', request_name => 'option', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Lightsail::HeaderObject | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Lightsail::HeaderObject object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { HeadersAllowList => $value, ..., Option => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::HeaderObject object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->HeadersAllowList | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Describes the request headers that a Lightsail distribution bases | ||
| 38 | caching on. | ||
| 39 | |||
| 40 | For the headers that you specify, your distribution caches separate | ||
| 41 | versions of the specified content based on the header values in viewer | ||
| 42 | requests. For example, suppose viewer requests for C<logo.jpg> contain | ||
| 43 | a custom C<product> header that has a value of either C<acme> or | ||
| 44 | C<apex>, and you configure your distribution to cache your content | ||
| 45 | based on values in the C<product> header. Your distribution forwards | ||
| 46 | the C<product> header to the origin and caches the response from the | ||
| 47 | origin once for each header value. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 HeadersAllowList => ArrayRef[Str|Undef] | ||
| 53 | |||
| 54 | The specific headers to forward to your distribution's origin. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Option => Str | ||
| 58 | |||
| 59 | The headers that you want your distribution to forward to your origin | ||
| 60 | and base caching on. | ||
| 61 | |||
| 62 | You can configure your distribution to do one of the following: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | B<C<all> > - Forward all headers to your origin. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | B<C<none> > - Forward only the default headers. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | B<C<allow-list> > - Forward only the headers you specify using the | ||
| 77 | C<headersAllowList> parameter. | ||
| 78 | |||
| 79 | =back | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |