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

#include <DefaultCacheBehavior.h>

Public Member Functions

 DefaultCacheBehavior ()
 
 DefaultCacheBehavior (const Aws::Utils::Xml::XmlNode &xmlNode)
 
DefaultCacheBehavioroperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::StringGetTargetOriginId () const
 
bool TargetOriginIdHasBeenSet () const
 
void SetTargetOriginId (const Aws::String &value)
 
void SetTargetOriginId (Aws::String &&value)
 
void SetTargetOriginId (const char *value)
 
DefaultCacheBehaviorWithTargetOriginId (const Aws::String &value)
 
DefaultCacheBehaviorWithTargetOriginId (Aws::String &&value)
 
DefaultCacheBehaviorWithTargetOriginId (const char *value)
 
const TrustedSignersGetTrustedSigners () const
 
bool TrustedSignersHasBeenSet () const
 
void SetTrustedSigners (const TrustedSigners &value)
 
void SetTrustedSigners (TrustedSigners &&value)
 
DefaultCacheBehaviorWithTrustedSigners (const TrustedSigners &value)
 
DefaultCacheBehaviorWithTrustedSigners (TrustedSigners &&value)
 
const TrustedKeyGroupsGetTrustedKeyGroups () const
 
bool TrustedKeyGroupsHasBeenSet () const
 
void SetTrustedKeyGroups (const TrustedKeyGroups &value)
 
void SetTrustedKeyGroups (TrustedKeyGroups &&value)
 
DefaultCacheBehaviorWithTrustedKeyGroups (const TrustedKeyGroups &value)
 
DefaultCacheBehaviorWithTrustedKeyGroups (TrustedKeyGroups &&value)
 
const ViewerProtocolPolicyGetViewerProtocolPolicy () const
 
bool ViewerProtocolPolicyHasBeenSet () const
 
void SetViewerProtocolPolicy (const ViewerProtocolPolicy &value)
 
void SetViewerProtocolPolicy (ViewerProtocolPolicy &&value)
 
DefaultCacheBehaviorWithViewerProtocolPolicy (const ViewerProtocolPolicy &value)
 
DefaultCacheBehaviorWithViewerProtocolPolicy (ViewerProtocolPolicy &&value)
 
const AllowedMethodsGetAllowedMethods () const
 
bool AllowedMethodsHasBeenSet () const
 
void SetAllowedMethods (const AllowedMethods &value)
 
void SetAllowedMethods (AllowedMethods &&value)
 
DefaultCacheBehaviorWithAllowedMethods (const AllowedMethods &value)
 
DefaultCacheBehaviorWithAllowedMethods (AllowedMethods &&value)
 
bool GetSmoothStreaming () const
 
bool SmoothStreamingHasBeenSet () const
 
void SetSmoothStreaming (bool value)
 
DefaultCacheBehaviorWithSmoothStreaming (bool value)
 
bool GetCompress () const
 
bool CompressHasBeenSet () const
 
void SetCompress (bool value)
 
DefaultCacheBehaviorWithCompress (bool value)
 
const LambdaFunctionAssociationsGetLambdaFunctionAssociations () const
 
bool LambdaFunctionAssociationsHasBeenSet () const
 
void SetLambdaFunctionAssociations (const LambdaFunctionAssociations &value)
 
void SetLambdaFunctionAssociations (LambdaFunctionAssociations &&value)
 
DefaultCacheBehaviorWithLambdaFunctionAssociations (const LambdaFunctionAssociations &value)
 
DefaultCacheBehaviorWithLambdaFunctionAssociations (LambdaFunctionAssociations &&value)
 
const FunctionAssociationsGetFunctionAssociations () const
 
bool FunctionAssociationsHasBeenSet () const
 
void SetFunctionAssociations (const FunctionAssociations &value)
 
void SetFunctionAssociations (FunctionAssociations &&value)
 
DefaultCacheBehaviorWithFunctionAssociations (const FunctionAssociations &value)
 
DefaultCacheBehaviorWithFunctionAssociations (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)
 
DefaultCacheBehaviorWithFieldLevelEncryptionId (const Aws::String &value)
 
DefaultCacheBehaviorWithFieldLevelEncryptionId (Aws::String &&value)
 
DefaultCacheBehaviorWithFieldLevelEncryptionId (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)
 
DefaultCacheBehaviorWithRealtimeLogConfigArn (const Aws::String &value)
 
DefaultCacheBehaviorWithRealtimeLogConfigArn (Aws::String &&value)
 
DefaultCacheBehaviorWithRealtimeLogConfigArn (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)
 
DefaultCacheBehaviorWithCachePolicyId (const Aws::String &value)
 
DefaultCacheBehaviorWithCachePolicyId (Aws::String &&value)
 
DefaultCacheBehaviorWithCachePolicyId (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)
 
DefaultCacheBehaviorWithOriginRequestPolicyId (const Aws::String &value)
 
DefaultCacheBehaviorWithOriginRequestPolicyId (Aws::String &&value)
 
DefaultCacheBehaviorWithOriginRequestPolicyId (const char *value)
 

Detailed Description

A complex type that describes the default cache behavior if you don’t specify a CacheBehavior element or if request URLs don’t match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

See Also:

AWS API Reference

Definition at line 39 of file DefaultCacheBehavior.h.

Constructor & Destructor Documentation

◆ DefaultCacheBehavior() [1/2]

Aws::CloudFront::Model::DefaultCacheBehavior::DefaultCacheBehavior ( )

◆ DefaultCacheBehavior() [2/2]

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

Member Function Documentation

◆ AddToNode()

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

◆ AllowedMethodsHasBeenSet()

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

Definition at line 429 of file DefaultCacheBehavior.h.

◆ CachePolicyIdHasBeenSet()

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

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

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

Definition at line 748 of file DefaultCacheBehavior.h.

◆ CompressHasBeenSet()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 501 of file DefaultCacheBehavior.h.

◆ FieldLevelEncryptionIdHasBeenSet()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 the default cache behavior.

Definition at line 614 of file DefaultCacheBehavior.h.

◆ FunctionAssociationsHasBeenSet()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 571 of file DefaultCacheBehavior.h.

◆ GetAllowedMethods()

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

Definition at line 426 of file DefaultCacheBehavior.h.

◆ GetCachePolicyId()

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

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

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

Definition at line 735 of file DefaultCacheBehavior.h.

◆ GetCompress()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 492 of file DefaultCacheBehavior.h.

◆ GetFieldLevelEncryptionId()

const Aws::String& Aws::CloudFront::Model::DefaultCacheBehavior::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 the default cache behavior.

Definition at line 607 of file DefaultCacheBehavior.h.

◆ GetFunctionAssociations()

const FunctionAssociations& Aws::CloudFront::Model::DefaultCacheBehavior::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 564 of file DefaultCacheBehavior.h.

◆ GetLambdaFunctionAssociations()

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

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

Definition at line 526 of file DefaultCacheBehavior.h.

◆ GetOriginRequestPolicyId()

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

The unique identifier of the origin request policy that is attached to the default 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 838 of file DefaultCacheBehavior.h.

◆ GetRealtimeLogConfigArn()

const Aws::String& Aws::CloudFront::Model::DefaultCacheBehavior::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 665 of file DefaultCacheBehavior.h.

◆ GetSmoothStreaming()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 452 of file DefaultCacheBehavior.h.

◆ GetTargetOriginId()

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

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

Definition at line 53 of file DefaultCacheBehavior.h.

◆ GetTrustedKeyGroups()

const TrustedKeyGroups& Aws::CloudFront::Model::DefaultCacheBehavior::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 200 of file DefaultCacheBehavior.h.

◆ GetTrustedSigners()

const TrustedSigners& Aws::CloudFront::Model::DefaultCacheBehavior::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 a 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 111 of file DefaultCacheBehavior.h.

◆ GetViewerProtocolPolicy()

const ViewerProtocolPolicy& Aws::CloudFront::Model::DefaultCacheBehavior::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 292 of file DefaultCacheBehavior.h.

◆ LambdaFunctionAssociationsHasBeenSet()

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

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

Definition at line 532 of file DefaultCacheBehavior.h.

◆ operator=()

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

◆ OriginRequestPolicyIdHasBeenSet()

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

The unique identifier of the origin request policy that is attached to the default 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 849 of file DefaultCacheBehavior.h.

◆ RealtimeLogConfigArnHasBeenSet()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 673 of file DefaultCacheBehavior.h.

◆ SetAllowedMethods() [1/2]

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

Definition at line 435 of file DefaultCacheBehavior.h.

◆ SetAllowedMethods() [2/2]

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

Definition at line 432 of file DefaultCacheBehavior.h.

◆ SetCachePolicyId() [1/3]

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

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

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

Definition at line 774 of file DefaultCacheBehavior.h.

◆ SetCachePolicyId() [2/3]

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

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

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

Definition at line 761 of file DefaultCacheBehavior.h.

◆ SetCachePolicyId() [3/3]

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

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

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

Definition at line 787 of file DefaultCacheBehavior.h.

◆ SetCompress()

void Aws::CloudFront::Model::DefaultCacheBehavior::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 510 of file DefaultCacheBehavior.h.

◆ SetFieldLevelEncryptionId() [1/3]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 the default cache behavior.

Definition at line 628 of file DefaultCacheBehavior.h.

◆ SetFieldLevelEncryptionId() [2/3]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 the default cache behavior.

Definition at line 621 of file DefaultCacheBehavior.h.

◆ SetFieldLevelEncryptionId() [3/3]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 the default cache behavior.

Definition at line 635 of file DefaultCacheBehavior.h.

◆ SetFunctionAssociations() [1/2]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 578 of file DefaultCacheBehavior.h.

◆ SetFunctionAssociations() [2/2]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 585 of file DefaultCacheBehavior.h.

◆ SetLambdaFunctionAssociations() [1/2]

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

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

Definition at line 538 of file DefaultCacheBehavior.h.

◆ SetLambdaFunctionAssociations() [2/2]

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

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

Definition at line 544 of file DefaultCacheBehavior.h.

◆ SetOriginRequestPolicyId() [1/3]

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

The unique identifier of the origin request policy that is attached to the default 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 871 of file DefaultCacheBehavior.h.

◆ SetOriginRequestPolicyId() [2/3]

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

The unique identifier of the origin request policy that is attached to the default 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 860 of file DefaultCacheBehavior.h.

◆ SetOriginRequestPolicyId() [3/3]

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

The unique identifier of the origin request policy that is attached to the default 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 882 of file DefaultCacheBehavior.h.

◆ SetRealtimeLogConfigArn() [1/3]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 689 of file DefaultCacheBehavior.h.

◆ SetRealtimeLogConfigArn() [2/3]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 681 of file DefaultCacheBehavior.h.

◆ SetRealtimeLogConfigArn() [3/3]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 697 of file DefaultCacheBehavior.h.

◆ SetSmoothStreaming()

void Aws::CloudFront::Model::DefaultCacheBehavior::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 472 of file DefaultCacheBehavior.h.

◆ SetTargetOriginId() [1/3]

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

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

Definition at line 71 of file DefaultCacheBehavior.h.

◆ SetTargetOriginId() [2/3]

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

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

Definition at line 65 of file DefaultCacheBehavior.h.

◆ SetTargetOriginId() [3/3]

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

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

Definition at line 77 of file DefaultCacheBehavior.h.

◆ SetTrustedKeyGroups() [1/2]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 226 of file DefaultCacheBehavior.h.

◆ SetTrustedKeyGroups() [2/2]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 239 of file DefaultCacheBehavior.h.

◆ SetTrustedSigners() [1/2]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 a 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 141 of file DefaultCacheBehavior.h.

◆ SetTrustedSigners() [2/2]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 a 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 156 of file DefaultCacheBehavior.h.

◆ SetViewerProtocolPolicy() [1/2]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 344 of file DefaultCacheBehavior.h.

◆ SetViewerProtocolPolicy() [2/2]

void Aws::CloudFront::Model::DefaultCacheBehavior::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 370 of file DefaultCacheBehavior.h.

◆ SmoothStreamingHasBeenSet()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 462 of file DefaultCacheBehavior.h.

◆ TargetOriginIdHasBeenSet()

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

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

Definition at line 59 of file DefaultCacheBehavior.h.

◆ TrustedKeyGroupsHasBeenSet()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 213 of file DefaultCacheBehavior.h.

◆ TrustedSignersHasBeenSet()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 a 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 126 of file DefaultCacheBehavior.h.

◆ ViewerProtocolPolicyHasBeenSet()

bool Aws::CloudFront::Model::DefaultCacheBehavior::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 318 of file DefaultCacheBehavior.h.

◆ WithAllowedMethods() [1/2]

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

Definition at line 441 of file DefaultCacheBehavior.h.

◆ WithAllowedMethods() [2/2]

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

Definition at line 438 of file DefaultCacheBehavior.h.

◆ WithCachePolicyId() [1/3]

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

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

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

Definition at line 813 of file DefaultCacheBehavior.h.

◆ WithCachePolicyId() [2/3]

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

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

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

Definition at line 800 of file DefaultCacheBehavior.h.

◆ WithCachePolicyId() [3/3]

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

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

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

Definition at line 826 of file DefaultCacheBehavior.h.

◆ WithCompress()

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 519 of file DefaultCacheBehavior.h.

◆ WithFieldLevelEncryptionId() [1/3]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 the default cache behavior.

Definition at line 649 of file DefaultCacheBehavior.h.

◆ WithFieldLevelEncryptionId() [2/3]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 the default cache behavior.

Definition at line 642 of file DefaultCacheBehavior.h.

◆ WithFieldLevelEncryptionId() [3/3]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 the default cache behavior.

Definition at line 656 of file DefaultCacheBehavior.h.

◆ WithFunctionAssociations() [1/2]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 592 of file DefaultCacheBehavior.h.

◆ WithFunctionAssociations() [2/2]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 599 of file DefaultCacheBehavior.h.

◆ WithLambdaFunctionAssociations() [1/2]

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

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

Definition at line 550 of file DefaultCacheBehavior.h.

◆ WithLambdaFunctionAssociations() [2/2]

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

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

Definition at line 556 of file DefaultCacheBehavior.h.

◆ WithOriginRequestPolicyId() [1/3]

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

The unique identifier of the origin request policy that is attached to the default 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 904 of file DefaultCacheBehavior.h.

◆ WithOriginRequestPolicyId() [2/3]

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

The unique identifier of the origin request policy that is attached to the default 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 893 of file DefaultCacheBehavior.h.

◆ WithOriginRequestPolicyId() [3/3]

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

The unique identifier of the origin request policy that is attached to the default 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 915 of file DefaultCacheBehavior.h.

◆ WithRealtimeLogConfigArn() [1/3]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 713 of file DefaultCacheBehavior.h.

◆ WithRealtimeLogConfigArn() [2/3]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 705 of file DefaultCacheBehavior.h.

◆ WithRealtimeLogConfigArn() [3/3]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 721 of file DefaultCacheBehavior.h.

◆ WithSmoothStreaming()

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 482 of file DefaultCacheBehavior.h.

◆ WithTargetOriginId() [1/3]

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

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

Definition at line 89 of file DefaultCacheBehavior.h.

◆ WithTargetOriginId() [2/3]

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

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

Definition at line 83 of file DefaultCacheBehavior.h.

◆ WithTargetOriginId() [3/3]

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

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

Definition at line 95 of file DefaultCacheBehavior.h.

◆ WithTrustedKeyGroups() [1/2]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 252 of file DefaultCacheBehavior.h.

◆ WithTrustedKeyGroups() [2/2]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 265 of file DefaultCacheBehavior.h.

◆ WithTrustedSigners() [1/2]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 a 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 171 of file DefaultCacheBehavior.h.

◆ WithTrustedSigners() [2/2]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 a 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 186 of file DefaultCacheBehavior.h.

◆ WithViewerProtocolPolicy() [1/2]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 396 of file DefaultCacheBehavior.h.

◆ WithViewerProtocolPolicy() [2/2]

DefaultCacheBehavior& Aws::CloudFront::Model::DefaultCacheBehavior::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 422 of file DefaultCacheBehavior.h.


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