AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin Class Reference

#include <ParametersInCacheKeyAndForwardedToOrigin.h>

Public Member Functions

 ParametersInCacheKeyAndForwardedToOrigin ()
 
 ParametersInCacheKeyAndForwardedToOrigin (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ParametersInCacheKeyAndForwardedToOriginoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
bool GetEnableAcceptEncodingGzip () const
 
bool EnableAcceptEncodingGzipHasBeenSet () const
 
void SetEnableAcceptEncodingGzip (bool value)
 
ParametersInCacheKeyAndForwardedToOriginWithEnableAcceptEncodingGzip (bool value)
 
bool GetEnableAcceptEncodingBrotli () const
 
bool EnableAcceptEncodingBrotliHasBeenSet () const
 
void SetEnableAcceptEncodingBrotli (bool value)
 
ParametersInCacheKeyAndForwardedToOriginWithEnableAcceptEncodingBrotli (bool value)
 
const CachePolicyHeadersConfigGetHeadersConfig () const
 
bool HeadersConfigHasBeenSet () const
 
void SetHeadersConfig (const CachePolicyHeadersConfig &value)
 
void SetHeadersConfig (CachePolicyHeadersConfig &&value)
 
ParametersInCacheKeyAndForwardedToOriginWithHeadersConfig (const CachePolicyHeadersConfig &value)
 
ParametersInCacheKeyAndForwardedToOriginWithHeadersConfig (CachePolicyHeadersConfig &&value)
 
const CachePolicyCookiesConfigGetCookiesConfig () const
 
bool CookiesConfigHasBeenSet () const
 
void SetCookiesConfig (const CachePolicyCookiesConfig &value)
 
void SetCookiesConfig (CachePolicyCookiesConfig &&value)
 
ParametersInCacheKeyAndForwardedToOriginWithCookiesConfig (const CachePolicyCookiesConfig &value)
 
ParametersInCacheKeyAndForwardedToOriginWithCookiesConfig (CachePolicyCookiesConfig &&value)
 
const CachePolicyQueryStringsConfigGetQueryStringsConfig () const
 
bool QueryStringsConfigHasBeenSet () const
 
void SetQueryStringsConfig (const CachePolicyQueryStringsConfig &value)
 
void SetQueryStringsConfig (CachePolicyQueryStringsConfig &&value)
 
ParametersInCacheKeyAndForwardedToOriginWithQueryStringsConfig (const CachePolicyQueryStringsConfig &value)
 
ParametersInCacheKeyAndForwardedToOriginWithQueryStringsConfig (CachePolicyQueryStringsConfig &&value)
 

Detailed Description

This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

See Also:

AWS API Reference

Definition at line 40 of file ParametersInCacheKeyAndForwardedToOrigin.h.

Constructor & Destructor Documentation

◆ ParametersInCacheKeyAndForwardedToOrigin() [1/2]

Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::ParametersInCacheKeyAndForwardedToOrigin ( )

◆ ParametersInCacheKeyAndForwardedToOrigin() [2/2]

Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::ParametersInCacheKeyAndForwardedToOrigin ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ CookiesConfigHasBeenSet()

bool Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::CookiesConfigHasBeenSet ( ) const
inline

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 323 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ EnableAcceptEncodingBrotliHasBeenSet()

bool Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::EnableAcceptEncodingBrotliHasBeenSet ( ) const
inline

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header

  • Includes the normalized header in the cache key

  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Definition at line 211 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ EnableAcceptEncodingGzipHasBeenSet()

bool Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::EnableAcceptEncodingGzipHasBeenSet ( ) const
inline

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header

  • Includes the normalized header in the cache key

  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Definition at line 102 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ GetCookiesConfig()

const CachePolicyCookiesConfig& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::GetCookiesConfig ( ) const
inline

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 316 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ GetEnableAcceptEncodingBrotli()

bool Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::GetEnableAcceptEncodingBrotli ( ) const
inline

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header

  • Includes the normalized header in the cache key

  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Definition at line 184 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ GetEnableAcceptEncodingGzip()

bool Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::GetEnableAcceptEncodingGzip ( ) const
inline

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header

  • Includes the normalized header in the cache key

  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Definition at line 75 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ GetHeadersConfig()

const CachePolicyHeadersConfig& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::GetHeadersConfig ( ) const
inline

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 273 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ GetQueryStringsConfig()

const CachePolicyQueryStringsConfig& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::GetQueryStringsConfig ( ) const
inline

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 359 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ HeadersConfigHasBeenSet()

bool Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::HeadersConfigHasBeenSet ( ) const
inline

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 280 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ operator=()

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ QueryStringsConfigHasBeenSet()

bool Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::QueryStringsConfigHasBeenSet ( ) const
inline

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 366 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ SetCookiesConfig() [1/2]

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::SetCookiesConfig ( CachePolicyCookiesConfig &&  value)
inline

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 337 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ SetCookiesConfig() [2/2]

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::SetCookiesConfig ( const CachePolicyCookiesConfig value)
inline

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 330 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ SetEnableAcceptEncodingBrotli()

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::SetEnableAcceptEncodingBrotli ( bool  value)
inline

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header

  • Includes the normalized header in the cache key

  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Definition at line 238 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ SetEnableAcceptEncodingGzip()

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::SetEnableAcceptEncodingGzip ( bool  value)
inline

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header

  • Includes the normalized header in the cache key

  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Definition at line 129 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ SetHeadersConfig() [1/2]

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::SetHeadersConfig ( CachePolicyHeadersConfig &&  value)
inline

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 294 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ SetHeadersConfig() [2/2]

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::SetHeadersConfig ( const CachePolicyHeadersConfig value)
inline

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 287 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ SetQueryStringsConfig() [1/2]

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::SetQueryStringsConfig ( CachePolicyQueryStringsConfig &&  value)
inline

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 380 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ SetQueryStringsConfig() [2/2]

void Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::SetQueryStringsConfig ( const CachePolicyQueryStringsConfig value)
inline

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 373 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ WithCookiesConfig() [1/2]

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::WithCookiesConfig ( CachePolicyCookiesConfig &&  value)
inline

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 351 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ WithCookiesConfig() [2/2]

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::WithCookiesConfig ( const CachePolicyCookiesConfig value)
inline

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 344 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ WithEnableAcceptEncodingBrotli()

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::WithEnableAcceptEncodingBrotli ( bool  value)
inline

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header

  • Includes the normalized header in the cache key

  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Definition at line 265 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ WithEnableAcceptEncodingGzip()

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::WithEnableAcceptEncodingGzip ( bool  value)
inline

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

  • Normalizes the value of the viewer’s Accept-Encoding header

  • Includes the normalized header in the cache key

  • Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Definition at line 156 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ WithHeadersConfig() [1/2]

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::WithHeadersConfig ( CachePolicyHeadersConfig &&  value)
inline

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 308 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ WithHeadersConfig() [2/2]

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::WithHeadersConfig ( const CachePolicyHeadersConfig value)
inline

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 301 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ WithQueryStringsConfig() [1/2]

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::WithQueryStringsConfig ( CachePolicyQueryStringsConfig &&  value)
inline

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 394 of file ParametersInCacheKeyAndForwardedToOrigin.h.

◆ WithQueryStringsConfig() [2/2]

ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::ParametersInCacheKeyAndForwardedToOrigin::WithQueryStringsConfig ( const CachePolicyQueryStringsConfig value)
inline

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Definition at line 387 of file ParametersInCacheKeyAndForwardedToOrigin.h.


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