Class: Aws::Lightsail::Types::CacheSettings
- Inherits:
-
Struct
- Object
- Struct
- Aws::Lightsail::Types::CacheSettings
- Defined in:
- gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb
Overview
When making an API call, you may pass CacheSettings data as a hash:
{
default_ttl: 1,
minimum_ttl: 1,
maximum_ttl: 1,
allowed_http_methods: "NonEmptyString",
cached_http_methods: "NonEmptyString",
forwarded_cookies: {
option: "none", # accepts none, allow-list, all
cookies_allow_list: ["string"],
},
forwarded_headers: {
option: "none", # accepts none, allow-list, all
headers_allow_list: ["Accept"], # accepts Accept, Accept-Charset, Accept-Datetime, Accept-Encoding, Accept-Language, Authorization, CloudFront-Forwarded-Proto, CloudFront-Is-Desktop-Viewer, CloudFront-Is-Mobile-Viewer, CloudFront-Is-SmartTV-Viewer, CloudFront-Is-Tablet-Viewer, CloudFront-Viewer-Country, Host, Origin, Referer
},
forwarded_query_strings: {
option: false,
query_strings_allow_list: ["string"],
},
}
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
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#allowed_http_methods ⇒ String
The HTTP methods that are processed and forwarded to the distribution's origin.
-
#cached_http_methods ⇒ String
The HTTP method responses that are cached by your distribution.
-
#default_ttl ⇒ Integer
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.
-
#forwarded_cookies ⇒ Types::CookieObject
An object that describes the cookies that are forwarded to the origin.
-
#forwarded_headers ⇒ Types::HeaderObject
An object that describes the headers that are forwarded to the origin.
-
#forwarded_query_strings ⇒ Types::QueryStringObject
An object that describes the query strings that are forwarded to the origin.
-
#maximum_ttl ⇒ Integer
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.
-
#minimum_ttl ⇒ Integer
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.
Instance Attribute Details
#allowed_http_methods ⇒ String
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.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1105 class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end |
#cached_http_methods ⇒ String
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.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1105 class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end |
#default_ttl ⇒ Integer
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.
Cache-Control max-age
, Cache-Control s-maxage
,
and Expires
to objects.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1105 class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end |
#forwarded_cookies ⇒ Types::CookieObject
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1105 class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end |
#forwarded_headers ⇒ Types::HeaderObject
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1105 class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end |
#forwarded_query_strings ⇒ Types::QueryStringObject
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.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1105 class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end |
#maximum_ttl ⇒ Integer
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.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1105 class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end |
#minimum_ttl ⇒ Integer
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.
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 |
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1105 class CacheSettings < Struct.new( :default_ttl, :minimum_ttl, :maximum_ttl, :allowed_http_methods, :cached_http_methods, :forwarded_cookies, :forwarded_headers, :forwarded_query_strings) SENSITIVE = [] include Aws::Structure end |