CacheSettings
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
.
Contents
- 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 theGET
andHEAD
methods. -
GET,HEAD,OPTIONS
- The distribution forwards theGET
,HEAD
, andOPTIONS
methods. -
GET,HEAD,OPTIONS,PUT,PATCH,POST,DELETE
- The distribution forwards theGET
,HEAD
,OPTIONS
,PUT
,PATCH
,POST
, andDELETE
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.
Type: String
Pattern:
.*\S.*
Required: No
-
- cachedHTTPMethods
-
The HTTP method responses that are cached by your distribution.
You can specify the following options:
-
GET,HEAD
- The distribution caches responses to theGET
andHEAD
methods. -
GET,HEAD,OPTIONS
- The distribution caches responses to theGET
,HEAD
, andOPTIONS
methods.
Type: String
Pattern:
.*\S.*
Required: No
-
- 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.
Note
The value specified applies only when the origin does not add HTTP headers such as
Cache-Control max-age
,Cache-Control s-maxage
, andExpires
to objects.Type: Long
Required: No
- forwardedCookies
-
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
Type: CookieObject object
Required: No
- forwardedHeaders
-
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
Type: HeaderObject object
Required: No
- 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.
Type: QueryStringObject object
Required: No
- 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
, andExpires
to objects.Type: Long
Required: No
- 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 forminimumTTL
if the distribution is configured to forward all headers to the origin.Type: Long
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: