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

#include <CacheBehavior.h>

Public Member Functions

 CacheBehavior ()
 
 CacheBehavior (const Aws::Utils::Xml::XmlNode &xmlNode)
 
CacheBehavioroperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::StringGetPathPattern () const
 
bool PathPatternHasBeenSet () const
 
void SetPathPattern (const Aws::String &value)
 
void SetPathPattern (Aws::String &&value)
 
void SetPathPattern (const char *value)
 
CacheBehaviorWithPathPattern (const Aws::String &value)
 
CacheBehaviorWithPathPattern (Aws::String &&value)
 
CacheBehaviorWithPathPattern (const char *value)
 
const Aws::StringGetTargetOriginId () const
 
bool TargetOriginIdHasBeenSet () const
 
void SetTargetOriginId (const Aws::String &value)
 
void SetTargetOriginId (Aws::String &&value)
 
void SetTargetOriginId (const char *value)
 
CacheBehaviorWithTargetOriginId (const Aws::String &value)
 
CacheBehaviorWithTargetOriginId (Aws::String &&value)
 
CacheBehaviorWithTargetOriginId (const char *value)
 
const TrustedSignersGetTrustedSigners () const
 
bool TrustedSignersHasBeenSet () const
 
void SetTrustedSigners (const TrustedSigners &value)
 
void SetTrustedSigners (TrustedSigners &&value)
 
CacheBehaviorWithTrustedSigners (const TrustedSigners &value)
 
CacheBehaviorWithTrustedSigners (TrustedSigners &&value)
 
const TrustedKeyGroupsGetTrustedKeyGroups () const
 
bool TrustedKeyGroupsHasBeenSet () const
 
void SetTrustedKeyGroups (const TrustedKeyGroups &value)
 
void SetTrustedKeyGroups (TrustedKeyGroups &&value)
 
CacheBehaviorWithTrustedKeyGroups (const TrustedKeyGroups &value)
 
CacheBehaviorWithTrustedKeyGroups (TrustedKeyGroups &&value)
 
const ViewerProtocolPolicyGetViewerProtocolPolicy () const
 
bool ViewerProtocolPolicyHasBeenSet () const
 
void SetViewerProtocolPolicy (const ViewerProtocolPolicy &value)
 
void SetViewerProtocolPolicy (ViewerProtocolPolicy &&value)
 
CacheBehaviorWithViewerProtocolPolicy (const ViewerProtocolPolicy &value)
 
CacheBehaviorWithViewerProtocolPolicy (ViewerProtocolPolicy &&value)
 
const AllowedMethodsGetAllowedMethods () const
 
bool AllowedMethodsHasBeenSet () const
 
void SetAllowedMethods (const AllowedMethods &value)
 
void SetAllowedMethods (AllowedMethods &&value)
 
CacheBehaviorWithAllowedMethods (const AllowedMethods &value)
 
CacheBehaviorWithAllowedMethods (AllowedMethods &&value)
 
bool GetSmoothStreaming () const
 
bool SmoothStreamingHasBeenSet () const
 
void SetSmoothStreaming (bool value)
 
CacheBehaviorWithSmoothStreaming (bool value)
 
bool GetCompress () const
 
bool CompressHasBeenSet () const
 
void SetCompress (bool value)
 
CacheBehaviorWithCompress (bool value)
 
const LambdaFunctionAssociationsGetLambdaFunctionAssociations () const
 
bool LambdaFunctionAssociationsHasBeenSet () const
 
void SetLambdaFunctionAssociations (const LambdaFunctionAssociations &value)
 
void SetLambdaFunctionAssociations (LambdaFunctionAssociations &&value)
 
CacheBehaviorWithLambdaFunctionAssociations (const LambdaFunctionAssociations &value)
 
CacheBehaviorWithLambdaFunctionAssociations (LambdaFunctionAssociations &&value)
 
const FunctionAssociationsGetFunctionAssociations () const
 
bool FunctionAssociationsHasBeenSet () const
 
void SetFunctionAssociations (const FunctionAssociations &value)
 
void SetFunctionAssociations (FunctionAssociations &&value)
 
CacheBehaviorWithFunctionAssociations (const FunctionAssociations &value)
 
CacheBehaviorWithFunctionAssociations (FunctionAssociations &&value)
 
const Aws::StringGetFieldLevelEncryptionId () const
 
bool FieldLevelEncryptionIdHasBeenSet () const
 
void SetFieldLevelEncryptionId (const Aws::String &value)
 
void SetFieldLevelEncryptionId (Aws::String &&value)
 
void SetFieldLevelEncryptionId (const char *value)
 
CacheBehaviorWithFieldLevelEncryptionId (const Aws::String &value)
 
CacheBehaviorWithFieldLevelEncryptionId (Aws::String &&value)
 
CacheBehaviorWithFieldLevelEncryptionId (const char *value)
 
const Aws::StringGetRealtimeLogConfigArn () const
 
bool RealtimeLogConfigArnHasBeenSet () const
 
void SetRealtimeLogConfigArn (const Aws::String &value)
 
void SetRealtimeLogConfigArn (Aws::String &&value)
 
void SetRealtimeLogConfigArn (const char *value)
 
CacheBehaviorWithRealtimeLogConfigArn (const Aws::String &value)
 
CacheBehaviorWithRealtimeLogConfigArn (Aws::String &&value)
 
CacheBehaviorWithRealtimeLogConfigArn (const char *value)
 
const Aws::StringGetCachePolicyId () const
 
bool CachePolicyIdHasBeenSet () const
 
void SetCachePolicyId (const Aws::String &value)
 
void SetCachePolicyId (Aws::String &&value)
 
void SetCachePolicyId (const char *value)
 
CacheBehaviorWithCachePolicyId (const Aws::String &value)
 
CacheBehaviorWithCachePolicyId (Aws::String &&value)
 
CacheBehaviorWithCachePolicyId (const char *value)
 
const Aws::StringGetOriginRequestPolicyId () const
 
bool OriginRequestPolicyIdHasBeenSet () const
 
void SetOriginRequestPolicyId (const Aws::String &value)
 
void SetOriginRequestPolicyId (Aws::String &&value)
 
void SetOriginRequestPolicyId (const char *value)
 
CacheBehaviorWithOriginRequestPolicyId (const Aws::String &value)
 
CacheBehaviorWithOriginRequestPolicyId (Aws::String &&value)
 
CacheBehaviorWithOriginRequestPolicyId (const char *value)
 

Detailed Description

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to serve objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current quota (formerly known as limit) on the number of cache behaviors that you can add to a distribution, see Quotas in the Amazon CloudFront Developer Guide.

If you don’t want to specify any cache behaviors, include only an empty CacheBehaviors element. Don’t include an empty CacheBehavior element because this is invalid.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

See Also:

AWS API Reference

Definition at line 57 of file CacheBehavior.h.

Constructor & Destructor Documentation

◆ CacheBehavior() [1/2]

Aws::CloudFront::Model::CacheBehavior::CacheBehavior ( )

◆ CacheBehavior() [2/2]

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

Member Function Documentation

◆ AddToNode()

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

◆ AllowedMethodsHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::AllowedMethodsHasBeenSet ( ) const
inline

Definition at line 584 of file CacheBehavior.h.

◆ CachePolicyIdHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::CachePolicyIdHasBeenSet ( ) const
inline

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

Definition at line 903 of file CacheBehavior.h.

◆ CompressHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::CompressHasBeenSet ( ) const
inline

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

Definition at line 656 of file CacheBehavior.h.

◆ FieldLevelEncryptionIdHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::FieldLevelEncryptionIdHasBeenSet ( ) const
inline

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

Definition at line 769 of file CacheBehavior.h.

◆ FunctionAssociationsHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::FunctionAssociationsHasBeenSet ( ) const
inline

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

Definition at line 726 of file CacheBehavior.h.

◆ GetAllowedMethods()

const AllowedMethods& Aws::CloudFront::Model::CacheBehavior::GetAllowedMethods ( ) const
inline

Definition at line 581 of file CacheBehavior.h.

◆ GetCachePolicyId()

const Aws::String& Aws::CloudFront::Model::CacheBehavior::GetCachePolicyId ( ) const
inline

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

Definition at line 890 of file CacheBehavior.h.

◆ GetCompress()

bool Aws::CloudFront::Model::CacheBehavior::GetCompress ( ) const
inline

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

Definition at line 647 of file CacheBehavior.h.

◆ GetFieldLevelEncryptionId()

const Aws::String& Aws::CloudFront::Model::CacheBehavior::GetFieldLevelEncryptionId ( ) const
inline

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

Definition at line 762 of file CacheBehavior.h.

◆ GetFunctionAssociations()

const FunctionAssociations& Aws::CloudFront::Model::CacheBehavior::GetFunctionAssociations ( ) const
inline

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

Definition at line 719 of file CacheBehavior.h.

◆ GetLambdaFunctionAssociations()

const LambdaFunctionAssociations& Aws::CloudFront::Model::CacheBehavior::GetLambdaFunctionAssociations ( ) const
inline

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

Definition at line 681 of file CacheBehavior.h.

◆ GetOriginRequestPolicyId()

const Aws::String& Aws::CloudFront::Model::CacheBehavior::GetOriginRequestPolicyId ( ) const
inline

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Definition at line 993 of file CacheBehavior.h.

◆ GetPathPattern()

const Aws::String& Aws::CloudFront::Model::CacheBehavior::GetPathPattern ( ) const
inline

The pattern (for example, images/ *.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/ *.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

Definition at line 82 of file CacheBehavior.h.

◆ GetRealtimeLogConfigArn()

const Aws::String& Aws::CloudFront::Model::CacheBehavior::GetRealtimeLogConfigArn ( ) const
inline

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Definition at line 820 of file CacheBehavior.h.

◆ GetSmoothStreaming()

bool Aws::CloudFront::Model::CacheBehavior::GetSmoothStreaming ( ) const
inline

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

Definition at line 607 of file CacheBehavior.h.

◆ GetTargetOriginId()

const Aws::String& Aws::CloudFront::Model::CacheBehavior::GetTargetOriginId ( ) const
inline

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

Definition at line 208 of file CacheBehavior.h.

◆ GetTrustedKeyGroups()

const TrustedKeyGroups& Aws::CloudFront::Model::CacheBehavior::GetTrustedKeyGroups ( ) const
inline

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 355 of file CacheBehavior.h.

◆ GetTrustedSigners()

const TrustedSigners& Aws::CloudFront::Model::CacheBehavior::GetTrustedSigners ( ) const
inline

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 266 of file CacheBehavior.h.

◆ GetViewerProtocolPolicy()

const ViewerProtocolPolicy& Aws::CloudFront::Model::CacheBehavior::GetViewerProtocolPolicy ( ) const
inline

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.

Definition at line 447 of file CacheBehavior.h.

◆ LambdaFunctionAssociationsHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::LambdaFunctionAssociationsHasBeenSet ( ) const
inline

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

Definition at line 687 of file CacheBehavior.h.

◆ operator=()

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

◆ OriginRequestPolicyIdHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::OriginRequestPolicyIdHasBeenSet ( ) const
inline

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Definition at line 1004 of file CacheBehavior.h.

◆ PathPatternHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::PathPatternHasBeenSet ( ) const
inline

The pattern (for example, images/ *.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/ *.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

Definition at line 99 of file CacheBehavior.h.

◆ RealtimeLogConfigArnHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::RealtimeLogConfigArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Definition at line 828 of file CacheBehavior.h.

◆ SetAllowedMethods() [1/2]

void Aws::CloudFront::Model::CacheBehavior::SetAllowedMethods ( AllowedMethods &&  value)
inline

Definition at line 590 of file CacheBehavior.h.

◆ SetAllowedMethods() [2/2]

void Aws::CloudFront::Model::CacheBehavior::SetAllowedMethods ( const AllowedMethods value)
inline

Definition at line 587 of file CacheBehavior.h.

◆ SetCachePolicyId() [1/3]

void Aws::CloudFront::Model::CacheBehavior::SetCachePolicyId ( Aws::String &&  value)
inline

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

Definition at line 929 of file CacheBehavior.h.

◆ SetCachePolicyId() [2/3]

void Aws::CloudFront::Model::CacheBehavior::SetCachePolicyId ( const Aws::String value)
inline

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

Definition at line 916 of file CacheBehavior.h.

◆ SetCachePolicyId() [3/3]

void Aws::CloudFront::Model::CacheBehavior::SetCachePolicyId ( const char *  value)
inline

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

Definition at line 942 of file CacheBehavior.h.

◆ SetCompress()

void Aws::CloudFront::Model::CacheBehavior::SetCompress ( bool  value)
inline

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

Definition at line 665 of file CacheBehavior.h.

◆ SetFieldLevelEncryptionId() [1/3]

void Aws::CloudFront::Model::CacheBehavior::SetFieldLevelEncryptionId ( Aws::String &&  value)
inline

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

Definition at line 783 of file CacheBehavior.h.

◆ SetFieldLevelEncryptionId() [2/3]

void Aws::CloudFront::Model::CacheBehavior::SetFieldLevelEncryptionId ( const Aws::String value)
inline

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

Definition at line 776 of file CacheBehavior.h.

◆ SetFieldLevelEncryptionId() [3/3]

void Aws::CloudFront::Model::CacheBehavior::SetFieldLevelEncryptionId ( const char *  value)
inline

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

Definition at line 790 of file CacheBehavior.h.

◆ SetFunctionAssociations() [1/2]

void Aws::CloudFront::Model::CacheBehavior::SetFunctionAssociations ( const FunctionAssociations value)
inline

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

Definition at line 733 of file CacheBehavior.h.

◆ SetFunctionAssociations() [2/2]

void Aws::CloudFront::Model::CacheBehavior::SetFunctionAssociations ( FunctionAssociations &&  value)
inline

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

Definition at line 740 of file CacheBehavior.h.

◆ SetLambdaFunctionAssociations() [1/2]

void Aws::CloudFront::Model::CacheBehavior::SetLambdaFunctionAssociations ( const LambdaFunctionAssociations value)
inline

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

Definition at line 693 of file CacheBehavior.h.

◆ SetLambdaFunctionAssociations() [2/2]

void Aws::CloudFront::Model::CacheBehavior::SetLambdaFunctionAssociations ( LambdaFunctionAssociations &&  value)
inline

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

Definition at line 699 of file CacheBehavior.h.

◆ SetOriginRequestPolicyId() [1/3]

void Aws::CloudFront::Model::CacheBehavior::SetOriginRequestPolicyId ( Aws::String &&  value)
inline

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Definition at line 1026 of file CacheBehavior.h.

◆ SetOriginRequestPolicyId() [2/3]

void Aws::CloudFront::Model::CacheBehavior::SetOriginRequestPolicyId ( const Aws::String value)
inline

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Definition at line 1015 of file CacheBehavior.h.

◆ SetOriginRequestPolicyId() [3/3]

void Aws::CloudFront::Model::CacheBehavior::SetOriginRequestPolicyId ( const char *  value)
inline

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Definition at line 1037 of file CacheBehavior.h.

◆ SetPathPattern() [1/3]

void Aws::CloudFront::Model::CacheBehavior::SetPathPattern ( Aws::String &&  value)
inline

The pattern (for example, images/ *.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/ *.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

Definition at line 133 of file CacheBehavior.h.

◆ SetPathPattern() [2/3]

void Aws::CloudFront::Model::CacheBehavior::SetPathPattern ( const Aws::String value)
inline

The pattern (for example, images/ *.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/ *.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

Definition at line 116 of file CacheBehavior.h.

◆ SetPathPattern() [3/3]

void Aws::CloudFront::Model::CacheBehavior::SetPathPattern ( const char *  value)
inline

The pattern (for example, images/ *.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/ *.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

Definition at line 150 of file CacheBehavior.h.

◆ SetRealtimeLogConfigArn() [1/3]

void Aws::CloudFront::Model::CacheBehavior::SetRealtimeLogConfigArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Definition at line 844 of file CacheBehavior.h.

◆ SetRealtimeLogConfigArn() [2/3]

void Aws::CloudFront::Model::CacheBehavior::SetRealtimeLogConfigArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Definition at line 836 of file CacheBehavior.h.

◆ SetRealtimeLogConfigArn() [3/3]

void Aws::CloudFront::Model::CacheBehavior::SetRealtimeLogConfigArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Definition at line 852 of file CacheBehavior.h.

◆ SetSmoothStreaming()

void Aws::CloudFront::Model::CacheBehavior::SetSmoothStreaming ( bool  value)
inline

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

Definition at line 627 of file CacheBehavior.h.

◆ SetTargetOriginId() [1/3]

void Aws::CloudFront::Model::CacheBehavior::SetTargetOriginId ( Aws::String &&  value)
inline

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

Definition at line 226 of file CacheBehavior.h.

◆ SetTargetOriginId() [2/3]

void Aws::CloudFront::Model::CacheBehavior::SetTargetOriginId ( const Aws::String value)
inline

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

Definition at line 220 of file CacheBehavior.h.

◆ SetTargetOriginId() [3/3]

void Aws::CloudFront::Model::CacheBehavior::SetTargetOriginId ( const char *  value)
inline

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

Definition at line 232 of file CacheBehavior.h.

◆ SetTrustedKeyGroups() [1/2]

void Aws::CloudFront::Model::CacheBehavior::SetTrustedKeyGroups ( const TrustedKeyGroups value)
inline

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 381 of file CacheBehavior.h.

◆ SetTrustedKeyGroups() [2/2]

void Aws::CloudFront::Model::CacheBehavior::SetTrustedKeyGroups ( TrustedKeyGroups &&  value)
inline

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 394 of file CacheBehavior.h.

◆ SetTrustedSigners() [1/2]

void Aws::CloudFront::Model::CacheBehavior::SetTrustedSigners ( const TrustedSigners value)
inline

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 296 of file CacheBehavior.h.

◆ SetTrustedSigners() [2/2]

void Aws::CloudFront::Model::CacheBehavior::SetTrustedSigners ( TrustedSigners &&  value)
inline

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 311 of file CacheBehavior.h.

◆ SetViewerProtocolPolicy() [1/2]

void Aws::CloudFront::Model::CacheBehavior::SetViewerProtocolPolicy ( const ViewerProtocolPolicy value)
inline

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.

Definition at line 499 of file CacheBehavior.h.

◆ SetViewerProtocolPolicy() [2/2]

void Aws::CloudFront::Model::CacheBehavior::SetViewerProtocolPolicy ( ViewerProtocolPolicy &&  value)
inline

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.

Definition at line 525 of file CacheBehavior.h.

◆ SmoothStreamingHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::SmoothStreamingHasBeenSet ( ) const
inline

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

Definition at line 617 of file CacheBehavior.h.

◆ TargetOriginIdHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::TargetOriginIdHasBeenSet ( ) const
inline

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

Definition at line 214 of file CacheBehavior.h.

◆ TrustedKeyGroupsHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::TrustedKeyGroupsHasBeenSet ( ) const
inline

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 368 of file CacheBehavior.h.

◆ TrustedSignersHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::TrustedSignersHasBeenSet ( ) const
inline

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 281 of file CacheBehavior.h.

◆ ViewerProtocolPolicyHasBeenSet()

bool Aws::CloudFront::Model::CacheBehavior::ViewerProtocolPolicyHasBeenSet ( ) const
inline

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.

Definition at line 473 of file CacheBehavior.h.

◆ WithAllowedMethods() [1/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithAllowedMethods ( AllowedMethods &&  value)
inline

Definition at line 596 of file CacheBehavior.h.

◆ WithAllowedMethods() [2/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithAllowedMethods ( const AllowedMethods value)
inline

Definition at line 593 of file CacheBehavior.h.

◆ WithCachePolicyId() [1/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithCachePolicyId ( Aws::String &&  value)
inline

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

Definition at line 968 of file CacheBehavior.h.

◆ WithCachePolicyId() [2/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithCachePolicyId ( const Aws::String value)
inline

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

Definition at line 955 of file CacheBehavior.h.

◆ WithCachePolicyId() [3/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithCachePolicyId ( const char *  value)
inline

The unique identifier of the cache policy that is attached to this cache behavior. For more information, see Creating cache policies or Using the managed cache policies in the Amazon CloudFront Developer Guide.

A CacheBehavior must include either a CachePolicyId or ForwardedValues. We recommend that you use a CachePolicyId.

Definition at line 981 of file CacheBehavior.h.

◆ WithCompress()

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithCompress ( bool  value)
inline

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

Definition at line 674 of file CacheBehavior.h.

◆ WithFieldLevelEncryptionId() [1/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithFieldLevelEncryptionId ( Aws::String &&  value)
inline

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

Definition at line 804 of file CacheBehavior.h.

◆ WithFieldLevelEncryptionId() [2/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithFieldLevelEncryptionId ( const Aws::String value)
inline

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

Definition at line 797 of file CacheBehavior.h.

◆ WithFieldLevelEncryptionId() [3/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithFieldLevelEncryptionId ( const char *  value)
inline

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.

Definition at line 811 of file CacheBehavior.h.

◆ WithFunctionAssociations() [1/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithFunctionAssociations ( const FunctionAssociations value)
inline

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

Definition at line 747 of file CacheBehavior.h.

◆ WithFunctionAssociations() [2/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithFunctionAssociations ( FunctionAssociations &&  value)
inline

A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the LIVE stage to associate them with a cache behavior.

Definition at line 754 of file CacheBehavior.h.

◆ WithLambdaFunctionAssociations() [1/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithLambdaFunctionAssociations ( const LambdaFunctionAssociations value)
inline

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

Definition at line 705 of file CacheBehavior.h.

◆ WithLambdaFunctionAssociations() [2/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithLambdaFunctionAssociations ( LambdaFunctionAssociations &&  value)
inline

A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.

Definition at line 711 of file CacheBehavior.h.

◆ WithOriginRequestPolicyId() [1/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithOriginRequestPolicyId ( Aws::String &&  value)
inline

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Definition at line 1059 of file CacheBehavior.h.

◆ WithOriginRequestPolicyId() [2/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithOriginRequestPolicyId ( const Aws::String value)
inline

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Definition at line 1048 of file CacheBehavior.h.

◆ WithOriginRequestPolicyId() [3/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithOriginRequestPolicyId ( const char *  value)
inline

The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see Creating origin request policies or Using the managed origin request policies in the Amazon CloudFront Developer Guide.

Definition at line 1070 of file CacheBehavior.h.

◆ WithPathPattern() [1/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithPathPattern ( Aws::String &&  value)
inline

The pattern (for example, images/ *.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/ *.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

Definition at line 184 of file CacheBehavior.h.

◆ WithPathPattern() [2/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithPathPattern ( const Aws::String value)
inline

The pattern (for example, images/ *.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/ *.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

Definition at line 167 of file CacheBehavior.h.

◆ WithPathPattern() [3/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithPathPattern ( const char *  value)
inline

The pattern (for example, images/ *.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/ *.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

Definition at line 201 of file CacheBehavior.h.

◆ WithRealtimeLogConfigArn() [1/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithRealtimeLogConfigArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Definition at line 868 of file CacheBehavior.h.

◆ WithRealtimeLogConfigArn() [2/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithRealtimeLogConfigArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Definition at line 860 of file CacheBehavior.h.

◆ WithRealtimeLogConfigArn() [3/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithRealtimeLogConfigArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see Real-time logs in the Amazon CloudFront Developer Guide.

Definition at line 876 of file CacheBehavior.h.

◆ WithSmoothStreaming()

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithSmoothStreaming ( bool  value)
inline

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

Definition at line 637 of file CacheBehavior.h.

◆ WithTargetOriginId() [1/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithTargetOriginId ( Aws::String &&  value)
inline

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

Definition at line 244 of file CacheBehavior.h.

◆ WithTargetOriginId() [2/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithTargetOriginId ( const Aws::String value)
inline

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

Definition at line 238 of file CacheBehavior.h.

◆ WithTargetOriginId() [3/3]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithTargetOriginId ( const char *  value)
inline

The value of ID for the origin that you want CloudFront to route requests to when they match this cache behavior.

Definition at line 250 of file CacheBehavior.h.

◆ WithTrustedKeyGroups() [1/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithTrustedKeyGroups ( const TrustedKeyGroups value)
inline

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 407 of file CacheBehavior.h.

◆ WithTrustedKeyGroups() [2/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithTrustedKeyGroups ( TrustedKeyGroups &&  value)
inline

A list of key groups that CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 420 of file CacheBehavior.h.

◆ WithTrustedSigners() [1/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithTrustedSigners ( const TrustedSigners value)
inline

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 326 of file CacheBehavior.h.

◆ WithTrustedSigners() [2/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithTrustedSigners ( TrustedSigners &&  value)
inline

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies.

When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer’s account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Definition at line 341 of file CacheBehavior.h.

◆ WithViewerProtocolPolicy() [1/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithViewerProtocolPolicy ( const ViewerProtocolPolicy value)
inline

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.

Definition at line 551 of file CacheBehavior.h.

◆ WithViewerProtocolPolicy() [2/2]

CacheBehavior& Aws::CloudFront::Model::CacheBehavior::WithViewerProtocolPolicy ( ViewerProtocolPolicy &&  value)
inline

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Requiring HTTPS Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects’ cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing Cache Expiration in the Amazon CloudFront Developer Guide.

Definition at line 577 of file CacheBehavior.h.


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