Interface CacheSettings.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CacheSettings.Builder,
,CacheSettings> SdkBuilder<CacheSettings.Builder,
,CacheSettings> SdkPojo
- Enclosing class:
CacheSettings
-
Method Summary
Modifier and TypeMethodDescriptionallowedHTTPMethods
(String allowedHTTPMethods) The HTTP methods that are processed and forwarded to the distribution's origin.cachedHTTPMethods
(String cachedHTTPMethods) The HTTP method responses that are cached by your distribution.defaultTTL
(Long 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.default CacheSettings.Builder
forwardedCookies
(Consumer<CookieObject.Builder> forwardedCookies) An object that describes the cookies that are forwarded to the origin.forwardedCookies
(CookieObject forwardedCookies) An object that describes the cookies that are forwarded to the origin.default CacheSettings.Builder
forwardedHeaders
(Consumer<HeaderObject.Builder> forwardedHeaders) An object that describes the headers that are forwarded to the origin.forwardedHeaders
(HeaderObject forwardedHeaders) An object that describes the headers that are forwarded to the origin.default CacheSettings.Builder
forwardedQueryStrings
(Consumer<QueryStringObject.Builder> forwardedQueryStrings) An object that describes the query strings that are forwarded to the origin.forwardedQueryStrings
(QueryStringObject forwardedQueryStrings) An object that describes the query strings that are forwarded to the origin.maximumTTL
(Long 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.minimumTTL
(Long 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.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
, andExpires
to objects.- Parameters:
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
, andExpires
to objects.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
forwardedCookies
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
- Parameters:
forwardedCookies
- An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
forwardedCookies
An object that describes the cookies that are forwarded to the origin. Your content is cached based on the cookies that are forwarded.
This is a convenience method that creates an instance of theCookieObject.Builder
avoiding the need to create one manually viaCookieObject.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toforwardedCookies(CookieObject)
.- Parameters:
forwardedCookies
- a consumer that will call methods onCookieObject.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
forwardedHeaders
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
- Parameters:
forwardedHeaders
- An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
forwardedHeaders
An object that describes the headers that are forwarded to the origin. Your content is cached based on the headers that are forwarded.
This is a convenience method that creates an instance of theHeaderObject.Builder
avoiding the need to create one manually viaHeaderObject.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toforwardedHeaders(HeaderObject)
.- Parameters:
forwardedHeaders
- a consumer that will call methods onHeaderObject.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
forwardedQueryStrings
default CacheSettings.Builder forwardedQueryStrings(Consumer<QueryStringObject.Builder> 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.
This is a convenience method that creates an instance of theQueryStringObject.Builder
avoiding the need to create one manually viaQueryStringObject.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toforwardedQueryStrings(QueryStringObject)
.- Parameters:
forwardedQueryStrings
- a consumer that will call methods onQueryStringObject.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-