You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Lightsail::Types::HeaderObject
- Inherits:
-
Struct
- Object
- Struct
- Aws::Lightsail::Types::HeaderObject
- Defined in:
- (unknown)
Overview
When passing HeaderObject as input to an Aws::Client method, you can use a vanilla 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
}
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.
Returned by:
Instance Attribute Summary collapse
-
#headers_allow_list ⇒ Array<String>
The specific headers to forward to your distribution\'s origin.
-
#option ⇒ String
The headers that you want your distribution to forward to your origin and base caching on.
Instance Attribute Details
#headers_allow_list ⇒ Array<String>
The specific headers to forward to your distribution\'s origin.
#option ⇒ String
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 theheadersAllowList
parameter.Possible values:
- none
- allow-list
- all