AWS SDK for C++  1.9.1
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)
 
DefaultCacheBehavior & operator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::String & GetTargetOriginId () const
 
bool TargetOriginIdHasBeenSet () const
 
void SetTargetOriginId (const Aws::String &value)
 
void SetTargetOriginId (Aws::String &&value)
 
void SetTargetOriginId (const char *value)
 
DefaultCacheBehavior & WithTargetOriginId (const Aws::String &value)
 
DefaultCacheBehavior & WithTargetOriginId (Aws::String &&value)
 
DefaultCacheBehavior & WithTargetOriginId (const char *value)
 
const TrustedSigners & GetTrustedSigners () const
 
bool TrustedSignersHasBeenSet () const
 
void SetTrustedSigners (const TrustedSigners &value)
 
void SetTrustedSigners (TrustedSigners &&value)
 
DefaultCacheBehavior & WithTrustedSigners (const TrustedSigners &value)
 
DefaultCacheBehavior & WithTrustedSigners (TrustedSigners &&value)
 
const TrustedKeyGroups & GetTrustedKeyGroups () const
 
bool TrustedKeyGroupsHasBeenSet () const
 
void SetTrustedKeyGroups (const TrustedKeyGroups &value)
 
void SetTrustedKeyGroups (TrustedKeyGroups &&value)
 
DefaultCacheBehavior & WithTrustedKeyGroups (const TrustedKeyGroups &value)
 
DefaultCacheBehavior & WithTrustedKeyGroups (TrustedKeyGroups &&value)
 
const ViewerProtocolPolicy & GetViewerProtocolPolicy () const
 
bool ViewerProtocolPolicyHasBeenSet () const
 
void SetViewerProtocolPolicy (const ViewerProtocolPolicy &value)
 
void SetViewerProtocolPolicy (ViewerProtocolPolicy &&value)
 
DefaultCacheBehavior & WithViewerProtocolPolicy (const ViewerProtocolPolicy &value)
 
DefaultCacheBehavior & WithViewerProtocolPolicy (ViewerProtocolPolicy &&value)
 
const AllowedMethods & GetAllowedMethods () const
 
bool AllowedMethodsHasBeenSet () const
 
void SetAllowedMethods (const AllowedMethods &value)
 
void SetAllowedMethods (AllowedMethods &&value)
 
DefaultCacheBehavior & WithAllowedMethods (const AllowedMethods &value)
 
DefaultCacheBehavior & WithAllowedMethods (AllowedMethods &&value)
 
bool GetSmoothStreaming () const
 
bool SmoothStreamingHasBeenSet () const
 
void SetSmoothStreaming (bool value)
 
DefaultCacheBehavior & WithSmoothStreaming (bool value)
 
bool GetCompress () const
 
bool CompressHasBeenSet () const
 
void SetCompress (bool value)
 
DefaultCacheBehavior & WithCompress (bool value)
 
const LambdaFunctionAssociations & GetLambdaFunctionAssociations () const
 
bool LambdaFunctionAssociationsHasBeenSet () const
 
void SetLambdaFunctionAssociations (const LambdaFunctionAssociations &value)
 
void SetLambdaFunctionAssociations (LambdaFunctionAssociations &&value)
 
DefaultCacheBehavior & WithLambdaFunctionAssociations (const LambdaFunctionAssociations &value)
 
DefaultCacheBehavior & WithLambdaFunctionAssociations (LambdaFunctionAssociations &&value)
 
const Aws::String & GetFieldLevelEncryptionId () const
 
bool FieldLevelEncryptionIdHasBeenSet () const
 
void SetFieldLevelEncryptionId (const Aws::String &value)
 
void SetFieldLevelEncryptionId (Aws::String &&value)
 
void SetFieldLevelEncryptionId (const char *value)
 
DefaultCacheBehavior & WithFieldLevelEncryptionId (const Aws::String &value)
 
DefaultCacheBehavior & WithFieldLevelEncryptionId (Aws::String &&value)
 
DefaultCacheBehavior & WithFieldLevelEncryptionId (const char *value)
 
const Aws::String & GetRealtimeLogConfigArn () const
 
bool RealtimeLogConfigArnHasBeenSet () const
 
void SetRealtimeLogConfigArn (const Aws::String &value)
 
void SetRealtimeLogConfigArn (Aws::String &&value)
 
void SetRealtimeLogConfigArn (const char *value)
 
DefaultCacheBehavior & WithRealtimeLogConfigArn (const Aws::String &value)
 
DefaultCacheBehavior & WithRealtimeLogConfigArn (Aws::String &&value)
 
DefaultCacheBehavior & WithRealtimeLogConfigArn (const char *value)
 
const Aws::String & GetCachePolicyId () const
 
bool CachePolicyIdHasBeenSet () const
 
void SetCachePolicyId (const Aws::String &value)
 
void SetCachePolicyId (Aws::String &&value)
 
void SetCachePolicyId (const char *value)
 
DefaultCacheBehavior & WithCachePolicyId (const Aws::String &value)
 
DefaultCacheBehavior & WithCachePolicyId (Aws::String &&value)
 
DefaultCacheBehavior & WithCachePolicyId (const char *value)
 
const Aws::String & GetOriginRequestPolicyId () const
 
bool OriginRequestPolicyIdHasBeenSet () const
 
void SetOriginRequestPolicyId (const Aws::String &value)
 
void SetOriginRequestPolicyId (Aws::String &&value)
 
void SetOriginRequestPolicyId (const char *value)
 
DefaultCacheBehavior & WithOriginRequestPolicyId (const Aws::String &value)
 
DefaultCacheBehavior & WithOriginRequestPolicyId (Aws::String &&value)
 
DefaultCacheBehavior & WithOriginRequestPolicyId (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 38 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 428 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.

Definition at line 700 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 500 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 570 of file DefaultCacheBehavior.h.

◆ GetAllowedMethods()

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

Definition at line 425 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.

Definition at line 689 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 491 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 563 of file DefaultCacheBehavior.h.

◆ GetLambdaFunctionAssociations()

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

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

Definition at line 525 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 778 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 621 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 451 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 52 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 199 of file DefaultCacheBehavior.h.

◆ GetTrustedSigners()

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

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of AWS 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 AWS 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 110 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 291 of file DefaultCacheBehavior.h.

◆ LambdaFunctionAssociationsHasBeenSet()

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

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

Definition at line 531 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 789 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 629 of file DefaultCacheBehavior.h.

◆ SetAllowedMethods() [1/2]

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

Definition at line 434 of file DefaultCacheBehavior.h.

◆ SetAllowedMethods() [2/2]

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

Definition at line 431 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.

Definition at line 722 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.

Definition at line 711 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.

Definition at line 733 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 509 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 584 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 577 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 591 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 function associations for a cache behavior.

Definition at line 537 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 function associations for a cache behavior.

Definition at line 543 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 811 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 800 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 822 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 645 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 637 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 653 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 471 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 70 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 64 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 76 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 225 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 238 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 AWS 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 AWS 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 140 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 AWS 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 AWS 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 155 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 343 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 369 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 461 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 58 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 212 of file DefaultCacheBehavior.h.

◆ TrustedSignersHasBeenSet()

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

We recommend using TrustedKeyGroups instead of TrustedSigners.

A list of AWS 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 AWS 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 125 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 317 of file DefaultCacheBehavior.h.

◆ WithAllowedMethods() [1/2]

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

Definition at line 440 of file DefaultCacheBehavior.h.

◆ WithAllowedMethods() [2/2]

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

Definition at line 437 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.

Definition at line 755 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.

Definition at line 744 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.

Definition at line 766 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 518 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 605 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 598 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 612 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 function associations for a cache behavior.

Definition at line 549 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 function associations for a cache behavior.

Definition at line 555 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 844 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 833 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 855 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 669 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 661 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 677 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 481 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 88 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 82 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 94 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 251 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 264 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 AWS 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 AWS 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 170 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 AWS 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 AWS 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 185 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 395 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 421 of file DefaultCacheBehavior.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.19
Privacy | Site terms | Cookie preferences