AWS SDK for C++  1.8.96
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::HeaderObject Class Reference

#include <HeaderObject.h>

Public Member Functions

 HeaderObject ()
 
 HeaderObject (Aws::Utils::Json::JsonView jsonValue)
 
HeaderObjectoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ForwardValuesGetOption () const
 
bool OptionHasBeenSet () const
 
void SetOption (const ForwardValues &value)
 
void SetOption (ForwardValues &&value)
 
HeaderObjectWithOption (const ForwardValues &value)
 
HeaderObjectWithOption (ForwardValues &&value)
 
const Aws::Vector< HeaderEnum > & GetHeadersAllowList () const
 
bool HeadersAllowListHasBeenSet () const
 
void SetHeadersAllowList (const Aws::Vector< HeaderEnum > &value)
 
void SetHeadersAllowList (Aws::Vector< HeaderEnum > &&value)
 
HeaderObjectWithHeadersAllowList (const Aws::Vector< HeaderEnum > &value)
 
HeaderObjectWithHeadersAllowList (Aws::Vector< HeaderEnum > &&value)
 
HeaderObjectAddHeadersAllowList (const HeaderEnum &value)
 
HeaderObjectAddHeadersAllowList (HeaderEnum &&value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 41 of file HeaderObject.h.

Constructor & Destructor Documentation

◆ HeaderObject() [1/2]

Aws::Lightsail::Model::HeaderObject::HeaderObject ( )

◆ HeaderObject() [2/2]

Aws::Lightsail::Model::HeaderObject::HeaderObject ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddHeadersAllowList() [1/2]

HeaderObject& Aws::Lightsail::Model::HeaderObject::AddHeadersAllowList ( const HeaderEnum value)
inline

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

Definition at line 150 of file HeaderObject.h.

◆ AddHeadersAllowList() [2/2]

HeaderObject& Aws::Lightsail::Model::HeaderObject::AddHeadersAllowList ( HeaderEnum &&  value)
inline

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

Definition at line 155 of file HeaderObject.h.

◆ GetHeadersAllowList()

const Aws::Vector<HeaderEnum>& Aws::Lightsail::Model::HeaderObject::GetHeadersAllowList ( ) const
inline

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

Definition at line 120 of file HeaderObject.h.

◆ GetOption()

const ForwardValues& Aws::Lightsail::Model::HeaderObject::GetOption ( ) const
inline

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.

Definition at line 59 of file HeaderObject.h.

◆ HeadersAllowListHasBeenSet()

bool Aws::Lightsail::Model::HeaderObject::HeadersAllowListHasBeenSet ( ) const
inline

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

Definition at line 125 of file HeaderObject.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::HeaderObject::Jsonize ( ) const

◆ operator=()

HeaderObject& Aws::Lightsail::Model::HeaderObject::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OptionHasBeenSet()

bool Aws::Lightsail::Model::HeaderObject::OptionHasBeenSet ( ) const
inline

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.

Definition at line 70 of file HeaderObject.h.

◆ SetHeadersAllowList() [1/2]

void Aws::Lightsail::Model::HeaderObject::SetHeadersAllowList ( const Aws::Vector< HeaderEnum > &  value)
inline

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

Definition at line 130 of file HeaderObject.h.

◆ SetHeadersAllowList() [2/2]

void Aws::Lightsail::Model::HeaderObject::SetHeadersAllowList ( Aws::Vector< HeaderEnum > &&  value)
inline

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

Definition at line 135 of file HeaderObject.h.

◆ SetOption() [1/2]

void Aws::Lightsail::Model::HeaderObject::SetOption ( const ForwardValues value)
inline

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.

Definition at line 81 of file HeaderObject.h.

◆ SetOption() [2/2]

void Aws::Lightsail::Model::HeaderObject::SetOption ( ForwardValues &&  value)
inline

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.

Definition at line 92 of file HeaderObject.h.

◆ WithHeadersAllowList() [1/2]

HeaderObject& Aws::Lightsail::Model::HeaderObject::WithHeadersAllowList ( const Aws::Vector< HeaderEnum > &  value)
inline

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

Definition at line 140 of file HeaderObject.h.

◆ WithHeadersAllowList() [2/2]

HeaderObject& Aws::Lightsail::Model::HeaderObject::WithHeadersAllowList ( Aws::Vector< HeaderEnum > &&  value)
inline

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

Definition at line 145 of file HeaderObject.h.

◆ WithOption() [1/2]

HeaderObject& Aws::Lightsail::Model::HeaderObject::WithOption ( const ForwardValues value)
inline

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.

Definition at line 103 of file HeaderObject.h.

◆ WithOption() [2/2]

HeaderObject& Aws::Lightsail::Model::HeaderObject::WithOption ( ForwardValues &&  value)
inline

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.

Definition at line 114 of file HeaderObject.h.


The documentation for this class was generated from the following file: