Skip to content

HeaderObject

Source code in docs_src/capo_lightsail/types/header_object.py
class HeaderObject(TypedDict, closed=True):
    option: NotRequired["capo_lightsail.types.forward_values.ForwardValues"]
    """<p>The headers that you want your distribution to forward to your origin and base caching on.</p> <p>You can configure your distribution to do one of the following:</p> <ul> <li> <p> <b> <code>all</code> </b> - Forward all headers to your origin.</p> </li> <li> <p> <b> <code>none</code> </b> - Forward only the default headers.</p> </li> <li> <p> <b> <code>allow-list</code> </b> - Forward only the headers you specify using the <code>headersAllowList</code> parameter.</p> </li> </ul>"""
    headers_allow_list: NotRequired[
        "capo_lightsail.types.header_forward_list.HeaderForwardList"
    ]
    """<p>The specific headers to forward to your distribution's origin.</p>"""

headers_allow_list instance-attribute

headers_allow_list: NotRequired[HeaderForwardList]

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

option instance-attribute

option: NotRequired[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.