NAME

Paws::Lightsail::HeaderObject

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Lightsail::HeaderObject object:

$service_obj->Method(Att1 => { HeadersAllowList => $value, ..., Option => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::HeaderObject object:

$result = $service_obj->Method(...);
$result->Att1->HeadersAllowList

DESCRIPTION

Describes the request headers that a Lightsail distribution bases caching on.

For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.

ATTRIBUTES

HeadersAllowList => ArrayRef[Str|Undef]

The specific headers to forward to your distribution's origin.

Option => Str

The headers that you want your distribution to forward to your origin and base caching on.

You can configure your distribution to do one of the following:

  • all - Forward all headers to your origin.

  • none - Forward only the default headers.

  • allow-list - Forward only the headers you specify using the headersAllowList parameter.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Lightsail

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues