AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A cache policy configuration.

This configuration determines the following:

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

Inheritance Hierarchy

System.Object
  Amazon.CloudFront.Model.CachePolicyConfig

Namespace: Amazon.CloudFront.Model
Assembly: AWSSDK.CloudFront.dll
Version: 3.x.y.z

Syntax

C# 
public class CachePolicyConfig

The CachePolicyConfig type exposes the following members

Constructors

NameDescription
Public Method CachePolicyConfig()

Properties

NameTypeDescription
Public Property Comment System.String

Gets and sets the property Comment.

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

Public Property DefaultTTL System.Int64

Gets and sets the property DefaultTTL.

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

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

Public Property MaxTTL System.Int64

Gets and sets the property MaxTTL.

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

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

Public Property MinTTL System.Int64

Gets and sets the property MinTTL.

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

Public Property Name System.String

Gets and sets the property Name.

A unique name to identify the cache policy.

Public Property ParametersInCacheKeyAndForwardedToOrigin Amazon.CloudFront.Model.ParametersInCacheKeyAndForwardedToOrigin

Gets and sets the property ParametersInCacheKeyAndForwardedToOrigin.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5