HeaderObject - Amazon Lightsail

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.

Contents

headersAllowList

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

Type: Array of strings

Valid Values: 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

Required: No

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:

  • 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.

Type: String

Valid Values: none | allow-list | all

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: