Skip to content

/AWS1/CL_FNTCACHEPOLICYCONFIG

A cache policy configuration.

This configuration determines the following:

  • The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

  • The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

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.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_NAME TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

A unique name to identify the cache policy.

IV_MINTTL TYPE /AWS1/FNTLONG /AWS1/FNTLONG

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.

Optional arguments:

IV_COMMENT TYPE /AWS1/FNTSTRING /AWS1/FNTSTRING

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

IV_DEFAULTTTL TYPE /AWS1/FNTLONG /AWS1/FNTLONG

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.

IV_MAXTTL TYPE /AWS1/FNTLONG /AWS1/FNTLONG

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.

IO_PRMSINCACHEKEYANDFORWAR00 TYPE REF TO /AWS1/CL_FNTPRMSINCACHEKEYAN00 /AWS1/CL_FNTPRMSINCACHEKEYAN00

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.

Queryable Attributes

Comment

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

Accessible with the following methods

Method Description
GET_COMMENT() Getter for COMMENT, with configurable default
ASK_COMMENT() Getter for COMMENT w/ exceptions if field has no value
HAS_COMMENT() Determine if COMMENT has a value

Name

A unique name to identify the cache policy.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

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.

Accessible with the following methods

Method Description
GET_DEFAULTTTL() Getter for DEFAULTTTL, with configurable default
ASK_DEFAULTTTL() Getter for DEFAULTTTL w/ exceptions if field has no value
HAS_DEFAULTTTL() Determine if DEFAULTTTL has a value

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.

Accessible with the following methods

Method Description
GET_MAXTTL() Getter for MAXTTL, with configurable default
ASK_MAXTTL() Getter for MAXTTL w/ exceptions if field has no value
HAS_MAXTTL() Determine if MAXTTL has a value

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.

Accessible with the following methods

Method Description
GET_MINTTL() Getter for MINTTL, with configurable default
ASK_MINTTL() Getter for MINTTL w/ exceptions if field has no value
HAS_MINTTL() Determine if MINTTL has a value

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.

Accessible with the following methods

Method Description
GET_PRMSINCACHEKEYANDFORWA00() Getter for PRMSINCACHEKEYANDFORWARDED00