Struct HeaderObject 

#[non_exhaustive]
pub struct HeaderObject {
    pub option: Option<ForwardValues>,
    pub headers_allow_list: Option<Vec<HeaderEnum>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

option: Option<ForwardValues>

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.

headers_allow_list: Option<Vec<HeaderEnum>>

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

Implementations

impl HeaderObject

pub fn option(&self) -> Option<&ForwardValues>

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.

pub fn headers_allow_list(&self) -> &[HeaderEnum]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .headers_allow_list.is_none().

impl HeaderObject

pub fn builder() -> HeaderObjectBuilder

Creates a new builder-style object to manufacture HeaderObject.

Trait Implementations

impl Clone for HeaderObject

fn clone(&self) -> HeaderObject

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HeaderObject

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for HeaderObject

fn eq(&self, other: &HeaderObject) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HeaderObject