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

#include <CachePolicyConfig.h>

Public Member Functions

 CachePolicyConfig ()
 
 CachePolicyConfig (const Aws::Utils::Xml::XmlNode &xmlNode)
 
CachePolicyConfigoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::StringGetComment () const
 
bool CommentHasBeenSet () const
 
void SetComment (const Aws::String &value)
 
void SetComment (Aws::String &&value)
 
void SetComment (const char *value)
 
CachePolicyConfigWithComment (const Aws::String &value)
 
CachePolicyConfigWithComment (Aws::String &&value)
 
CachePolicyConfigWithComment (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CachePolicyConfigWithName (const Aws::String &value)
 
CachePolicyConfigWithName (Aws::String &&value)
 
CachePolicyConfigWithName (const char *value)
 
long long GetDefaultTTL () const
 
bool DefaultTTLHasBeenSet () const
 
void SetDefaultTTL (long long value)
 
CachePolicyConfigWithDefaultTTL (long long value)
 
long long GetMaxTTL () const
 
bool MaxTTLHasBeenSet () const
 
void SetMaxTTL (long long value)
 
CachePolicyConfigWithMaxTTL (long long value)
 
long long GetMinTTL () const
 
bool MinTTLHasBeenSet () const
 
void SetMinTTL (long long value)
 
CachePolicyConfigWithMinTTL (long long value)
 
const ParametersInCacheKeyAndForwardedToOriginGetParametersInCacheKeyAndForwardedToOrigin () const
 
bool ParametersInCacheKeyAndForwardedToOriginHasBeenSet () const
 
void SetParametersInCacheKeyAndForwardedToOrigin (const ParametersInCacheKeyAndForwardedToOrigin &value)
 
void SetParametersInCacheKeyAndForwardedToOrigin (ParametersInCacheKeyAndForwardedToOrigin &&value)
 
CachePolicyConfigWithParametersInCacheKeyAndForwardedToOrigin (const ParametersInCacheKeyAndForwardedToOrigin &value)
 
CachePolicyConfigWithParametersInCacheKeyAndForwardedToOrigin (ParametersInCacheKeyAndForwardedToOrigin &&value)
 

Detailed Description

A cache policy configuration.

This configuration determines the following:

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 a valid 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 42 of file CachePolicyConfig.h.

Constructor & Destructor Documentation

◆ CachePolicyConfig() [1/2]

Aws::CloudFront::Model::CachePolicyConfig::CachePolicyConfig ( )

◆ CachePolicyConfig() [2/2]

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

Member Function Documentation

◆ AddToNode()

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

◆ CommentHasBeenSet()

bool Aws::CloudFront::Model::CachePolicyConfig::CommentHasBeenSet ( ) const
inline

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Definition at line 62 of file CachePolicyConfig.h.

◆ DefaultTTLHasBeenSet()

bool Aws::CloudFront::Model::CachePolicyConfig::DefaultTTLHasBeenSet ( ) const
inline

The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.

Definition at line 170 of file CachePolicyConfig.h.

◆ GetComment()

const Aws::String& Aws::CloudFront::Model::CachePolicyConfig::GetComment ( ) const
inline

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Definition at line 56 of file CachePolicyConfig.h.

◆ GetDefaultTTL()

long long Aws::CloudFront::Model::CachePolicyConfig::GetDefaultTTL ( ) const
inline

The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.

Definition at line 155 of file CachePolicyConfig.h.

◆ GetMaxTTL()

long long Aws::CloudFront::Model::CachePolicyConfig::GetMaxTTL ( ) const
inline

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.

Definition at line 216 of file CachePolicyConfig.h.

◆ GetMinTTL()

long long Aws::CloudFront::Model::CachePolicyConfig::GetMinTTL ( ) const
inline

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Definition at line 272 of file CachePolicyConfig.h.

◆ GetName()

const Aws::String& Aws::CloudFront::Model::CachePolicyConfig::GetName ( ) const
inline

A unique name to identify the cache policy.

Definition at line 104 of file CachePolicyConfig.h.

◆ GetParametersInCacheKeyAndForwardedToOrigin()

const ParametersInCacheKeyAndForwardedToOrigin& Aws::CloudFront::Model::CachePolicyConfig::GetParametersInCacheKeyAndForwardedToOrigin ( ) const
inline

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Definition at line 310 of file CachePolicyConfig.h.

◆ MaxTTLHasBeenSet()

bool Aws::CloudFront::Model::CachePolicyConfig::MaxTTLHasBeenSet ( ) const
inline

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.

Definition at line 231 of file CachePolicyConfig.h.

◆ MinTTLHasBeenSet()

bool Aws::CloudFront::Model::CachePolicyConfig::MinTTLHasBeenSet ( ) const
inline

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Definition at line 282 of file CachePolicyConfig.h.

◆ NameHasBeenSet()

bool Aws::CloudFront::Model::CachePolicyConfig::NameHasBeenSet ( ) const
inline

A unique name to identify the cache policy.

Definition at line 109 of file CachePolicyConfig.h.

◆ operator=()

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

◆ ParametersInCacheKeyAndForwardedToOriginHasBeenSet()

bool Aws::CloudFront::Model::CachePolicyConfig::ParametersInCacheKeyAndForwardedToOriginHasBeenSet ( ) const
inline

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Definition at line 317 of file CachePolicyConfig.h.

◆ SetComment() [1/3]

void Aws::CloudFront::Model::CachePolicyConfig::SetComment ( Aws::String &&  value)
inline

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Definition at line 74 of file CachePolicyConfig.h.

◆ SetComment() [2/3]

void Aws::CloudFront::Model::CachePolicyConfig::SetComment ( const Aws::String value)
inline

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Definition at line 68 of file CachePolicyConfig.h.

◆ SetComment() [3/3]

void Aws::CloudFront::Model::CachePolicyConfig::SetComment ( const char *  value)
inline

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Definition at line 80 of file CachePolicyConfig.h.

◆ SetDefaultTTL()

void Aws::CloudFront::Model::CachePolicyConfig::SetDefaultTTL ( long long  value)
inline

The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.

Definition at line 185 of file CachePolicyConfig.h.

◆ SetMaxTTL()

void Aws::CloudFront::Model::CachePolicyConfig::SetMaxTTL ( long long  value)
inline

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.

Definition at line 246 of file CachePolicyConfig.h.

◆ SetMinTTL()

void Aws::CloudFront::Model::CachePolicyConfig::SetMinTTL ( long long  value)
inline

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Definition at line 292 of file CachePolicyConfig.h.

◆ SetName() [1/3]

void Aws::CloudFront::Model::CachePolicyConfig::SetName ( Aws::String &&  value)
inline

A unique name to identify the cache policy.

Definition at line 119 of file CachePolicyConfig.h.

◆ SetName() [2/3]

void Aws::CloudFront::Model::CachePolicyConfig::SetName ( const Aws::String value)
inline

A unique name to identify the cache policy.

Definition at line 114 of file CachePolicyConfig.h.

◆ SetName() [3/3]

void Aws::CloudFront::Model::CachePolicyConfig::SetName ( const char *  value)
inline

A unique name to identify the cache policy.

Definition at line 124 of file CachePolicyConfig.h.

◆ SetParametersInCacheKeyAndForwardedToOrigin() [1/2]

void Aws::CloudFront::Model::CachePolicyConfig::SetParametersInCacheKeyAndForwardedToOrigin ( const ParametersInCacheKeyAndForwardedToOrigin value)
inline

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Definition at line 324 of file CachePolicyConfig.h.

◆ SetParametersInCacheKeyAndForwardedToOrigin() [2/2]

void Aws::CloudFront::Model::CachePolicyConfig::SetParametersInCacheKeyAndForwardedToOrigin ( ParametersInCacheKeyAndForwardedToOrigin &&  value)
inline

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Definition at line 331 of file CachePolicyConfig.h.

◆ WithComment() [1/3]

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithComment ( Aws::String &&  value)
inline

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Definition at line 92 of file CachePolicyConfig.h.

◆ WithComment() [2/3]

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithComment ( const Aws::String value)
inline

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Definition at line 86 of file CachePolicyConfig.h.

◆ WithComment() [3/3]

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithComment ( const char *  value)
inline

A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Definition at line 98 of file CachePolicyConfig.h.

◆ WithDefaultTTL()

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithDefaultTTL ( long long  value)
inline

The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than 86400 seconds, then the default value for this field is the same as the value of MinTTL.

Definition at line 200 of file CachePolicyConfig.h.

◆ WithMaxTTL()

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithMaxTTL ( long long  value)
inline

The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

The default value for this field is 31536000 seconds (one year). If the value of MinTTL or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL.

Definition at line 261 of file CachePolicyConfig.h.

◆ WithMinTTL()

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithMinTTL ( long long  value)
inline

The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

Definition at line 302 of file CachePolicyConfig.h.

◆ WithName() [1/3]

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithName ( Aws::String &&  value)
inline

A unique name to identify the cache policy.

Definition at line 134 of file CachePolicyConfig.h.

◆ WithName() [2/3]

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithName ( const Aws::String value)
inline

A unique name to identify the cache policy.

Definition at line 129 of file CachePolicyConfig.h.

◆ WithName() [3/3]

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithName ( const char *  value)
inline

A unique name to identify the cache policy.

Definition at line 139 of file CachePolicyConfig.h.

◆ WithParametersInCacheKeyAndForwardedToOrigin() [1/2]

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithParametersInCacheKeyAndForwardedToOrigin ( const ParametersInCacheKeyAndForwardedToOrigin value)
inline

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Definition at line 338 of file CachePolicyConfig.h.

◆ WithParametersInCacheKeyAndForwardedToOrigin() [2/2]

CachePolicyConfig& Aws::CloudFront::Model::CachePolicyConfig::WithParametersInCacheKeyAndForwardedToOrigin ( ParametersInCacheKeyAndForwardedToOrigin &&  value)
inline

The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.

Definition at line 345 of file CachePolicyConfig.h.


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