Skip to content

/AWS1/CL_LSACACHESETTINGS

Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.

These settings apply only to your distribution's cacheBehaviors (including the defaultCacheBehavior) that have a behavior of cache.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_defaultttl TYPE /AWS1/LSALONG /AWS1/LSALONG

The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

iv_minimumttl TYPE /AWS1/LSALONG /AWS1/LSALONG

The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.

iv_maximumttl TYPE /AWS1/LSALONG /AWS1/LSALONG

The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

iv_allowedhttpmethods TYPE /AWS1/LSANONEMPTYSTRING /AWS1/LSANONEMPTYSTRING

The HTTP methods that are processed and forwarded to the distribution's origin.

You can specify the following options:

  • GET,HEAD - The distribution forwards the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.

  • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.

iv_cachedhttpmethods TYPE /AWS1/LSANONEMPTYSTRING /AWS1/LSANONEMPTYSTRING

The HTTP method responses that are cached by your distribution.

You can specify the following options:

  • GET,HEAD - The distribution caches responses to the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

io_forwardedcookies TYPE REF TO /AWS1/CL_LSACOOKIEOBJECT /AWS1/CL_LSACOOKIEOBJECT

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.

io_forwardedheaders TYPE REF TO /AWS1/CL_LSAHEADEROBJECT /AWS1/CL_LSAHEADEROBJECT

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.

io_forwardedquerystrings TYPE REF TO /AWS1/CL_LSAQUERYSTRINGOBJECT /AWS1/CL_LSAQUERYSTRINGOBJECT

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.

Queryable Attributes

defaultTTL

The default amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the content has been updated.

The value specified applies only when the origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

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

minimumTTL

The minimum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

A value of 0 must be specified for minimumTTL if the distribution is configured to forward all headers to the origin.

Accessible with the following methods

Method Description
GET_MINIMUMTTL() Getter for MINIMUMTTL, with configurable default
ASK_MINIMUMTTL() Getter for MINIMUMTTL w/ exceptions if field has no value
HAS_MINIMUMTTL() Determine if MINIMUMTTL has a value

maximumTTL

The maximum amount of time that objects stay in the distribution's cache before the distribution forwards another request to the origin to determine whether the object has been updated.

The value specified applies only when the origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects.

Accessible with the following methods

Method Description
GET_MAXIMUMTTL() Getter for MAXIMUMTTL, with configurable default
ASK_MAXIMUMTTL() Getter for MAXIMUMTTL w/ exceptions if field has no value
HAS_MAXIMUMTTL() Determine if MAXIMUMTTL has a value

allowedHTTPMethods

The HTTP methods that are processed and forwarded to the distribution's origin.

You can specify the following options:

  • GET,HEAD - The distribution forwards the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution forwards the GET, HEAD, and OPTIONS methods.

  • GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE - The distribution forwards the GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE methods.

If you specify the third option, you might need to restrict access to your distribution's origin so users can't perform operations that you don't want them to. For example, you might not want users to have permission to delete objects from your origin.

Accessible with the following methods

Method Description
GET_ALLOWEDHTTPMETHODS() Getter for ALLOWEDHTTPMETHODS, with configurable default
ASK_ALLOWEDHTTPMETHODS() Getter for ALLOWEDHTTPMETHODS w/ exceptions if field has no
HAS_ALLOWEDHTTPMETHODS() Determine if ALLOWEDHTTPMETHODS has a value

cachedHTTPMethods

The HTTP method responses that are cached by your distribution.

You can specify the following options:

  • GET,HEAD - The distribution caches responses to the GET and HEAD methods.

  • GET,HEAD,OPTIONS - The distribution caches responses to the GET, HEAD, and OPTIONS methods.

Accessible with the following methods

Method Description
GET_CACHEDHTTPMETHODS() Getter for CACHEDHTTPMETHODS, with configurable default
ASK_CACHEDHTTPMETHODS() Getter for CACHEDHTTPMETHODS w/ exceptions if field has no v
HAS_CACHEDHTTPMETHODS() Determine if CACHEDHTTPMETHODS has a value

forwardedCookies

An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.

Accessible with the following methods

Method Description
GET_FORWARDEDCOOKIES() Getter for FORWARDEDCOOKIES

forwardedHeaders

An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.

Accessible with the following methods

Method Description
GET_FORWARDEDHEADERS() Getter for FORWARDEDHEADERS

forwardedQueryStrings

An object that describes the query strings that are forwarded to the origin. Your content is cached based on the query strings that are forwarded.

Accessible with the following methods

Method Description
GET_FORWARDEDQUERYSTRINGS() Getter for FORWARDEDQUERYSTRINGS