class Aws::Lightsail::Types::HeaderObject

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.

@note When making an API call, you may pass HeaderObject

data as a hash:

    {
      option: "none", # accepts none, allow-list, all
      headers_allow_list: ["Accept"], # accepts Accept, Accept-Charset, Accept-Datetime, Accept-Encoding, Accept-Language, Authorization, CloudFront-Forwarded-Proto, CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer, CloudFront-Is-SmartTV-Viewer, CloudFront-Is-Tablet-Viewer, CloudFront-Viewer-Country, Host, Origin, Referer
    }

@!attribute [rw] option

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:

* <b> <code>all</code> </b> - Forward all headers to your origin.

* <b> <code>none</code> </b> - Forward only the default headers.

* <b> <code>allow-list</code> </b> - Forward only the headers you
  specify using the `headersAllowList` parameter.
@return [String]

@!attribute [rw] headers_allow_list

The specific headers to forward to your distribution's origin.
@return [Array<String>]

@see docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/HeaderObject AWS API Documentation

Constants

SENSITIVE