software.amazon.awssdk.services.lightsail.model

Interface CacheSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CacheSettings.Builder,CacheSettings>, SdkBuilder<CacheSettings.Builder,CacheSettings>, SdkPojo

Enclosing class:

CacheSettings

public static interface CacheSettings.Builder
extends SdkPojo, CopyableBuilder<CacheSettings.Builder,CacheSettings>

Method Summary

Modifier and Type	Method and Description
CacheSettings.Builder	allowedHTTPMethods(String allowedHTTPMethods) The HTTP methods that are processed and forwarded to the distribution's origin.
CacheSettings.Builder	cachedHTTPMethods(String cachedHTTPMethods) The HTTP method responses that are cached by your distribution.
CacheSettings.Builder	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.
CacheSettings.Builder	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.
CacheSettings.Builder	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.
CacheSettings.Builder	forwardedQueryStrings(QueryStringObject forwardedQueryStrings) An object that describes the query strings that are forwarded to the origin.
CacheSettings.Builder	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.
CacheSettings.Builder	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.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

defaultTTL

CacheSettings.Builder 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.

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.

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, and Expires to objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

minimumTTL

CacheSettings.Builder 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.

A value of 0 must be specified for minimumTTL 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 for minimumTTL 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

CacheSettings.Builder 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.

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.

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, and Expires to objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedHTTPMethods

CacheSettings.Builder allowedHTTPMethods(String 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.

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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

cachedHTTPMethods

CacheSettings.Builder cachedHTTPMethods(String 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.

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 the GET and HEAD methods.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

forwardedCookies

CacheSettings.Builder forwardedCookies(CookieObject 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

default CacheSettings.Builder forwardedCookies(Consumer<CookieObject.Builder> 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 that creates an instance of the CookieObject.Builder avoiding the need to create one manually via CookieObject.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to forwardedCookies(CookieObject).

Parameters:

forwardedCookies - a consumer that will call methods on CookieObject.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

forwardedCookies(CookieObject)

forwardedHeaders

CacheSettings.Builder forwardedHeaders(HeaderObject 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

default CacheSettings.Builder forwardedHeaders(Consumer<HeaderObject.Builder> 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 that creates an instance of the HeaderObject.Builder avoiding the need to create one manually via HeaderObject.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to forwardedHeaders(HeaderObject).

Parameters:

forwardedHeaders - a consumer that will call methods on HeaderObject.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

forwardedHeaders(HeaderObject)

forwardedQueryStrings

CacheSettings.Builder forwardedQueryStrings(QueryStringObject 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 that creates an instance of the QueryStringObject.Builder avoiding the need to create one manually via QueryStringObject.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to forwardedQueryStrings(QueryStringObject).

Parameters:

forwardedQueryStrings - a consumer that will call methods on QueryStringObject.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

forwardedQueryStrings(QueryStringObject)