com.amazonaws.services.lightsail.model

Class CacheSettings

java.lang.Object

com.amazonaws.services.lightsail.model.CacheSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CacheSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CacheSettings()

Method Summary

Modifier and Type	Method and Description
CacheSettings	clone()
boolean	equals(Object obj)
String	getAllowedHTTPMethods() The HTTP methods that are processed and forwarded to the distribution's origin.
String	getCachedHTTPMethods() The HTTP method responses that are cached by your distribution.
Long	getDefaultTTL() 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.
CookieObject	getForwardedCookies() An object that describes the cookies that are forwarded to the origin.
HeaderObject	getForwardedHeaders() An object that describes the headers that are forwarded to the origin.
QueryStringObject	getForwardedQueryStrings() An object that describes the query strings that are forwarded to the origin.
Long	getMaximumTTL() 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.
Long	getMinimumTTL() 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.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAllowedHTTPMethods(String allowedHTTPMethods) The HTTP methods that are processed and forwarded to the distribution's origin.
void	setCachedHTTPMethods(String cachedHTTPMethods) The HTTP method responses that are cached by your distribution.
void	setDefaultTTL(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.
void	setForwardedCookies(CookieObject forwardedCookies) An object that describes the cookies that are forwarded to the origin.
void	setForwardedHeaders(HeaderObject forwardedHeaders) An object that describes the headers that are forwarded to the origin.
void	setForwardedQueryStrings(QueryStringObject forwardedQueryStrings) An object that describes the query strings that are forwarded to the origin.
void	setMaximumTTL(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.
void	setMinimumTTL(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.
String	toString() Returns a string representation of this object.
CacheSettings	withAllowedHTTPMethods(String allowedHTTPMethods) The HTTP methods that are processed and forwarded to the distribution's origin.
CacheSettings	withCachedHTTPMethods(String cachedHTTPMethods) The HTTP method responses that are cached by your distribution.
CacheSettings	withDefaultTTL(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.
CacheSettings	withForwardedCookies(CookieObject forwardedCookies) An object that describes the cookies that are forwarded to the origin.
CacheSettings	withForwardedHeaders(HeaderObject forwardedHeaders) An object that describes the headers that are forwarded to the origin.
CacheSettings	withForwardedQueryStrings(QueryStringObject forwardedQueryStrings) An object that describes the query strings that are forwarded to the origin.
CacheSettings	withMaximumTTL(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	withMinimumTTL(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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CacheSettings

public CacheSettings()

Method Detail

setDefaultTTL

public void setDefaultTTL(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.

getDefaultTTL

public Long getDefaultTTL()

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:

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.

withDefaultTTL

public CacheSettings withDefaultTTL(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.

setMinimumTTL

public void setMinimumTTL(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.

getMinimumTTL

public Long getMinimumTTL()

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:

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.

withMinimumTTL

public CacheSettings withMinimumTTL(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.

setMaximumTTL

public void setMaximumTTL(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.

getMaximumTTL

public Long getMaximumTTL()

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:

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.

withMaximumTTL

public CacheSettings withMaximumTTL(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.

setAllowedHTTPMethods

public void setAllowedHTTPMethods(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.

getAllowedHTTPMethods

public String getAllowedHTTPMethods()

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:

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.

withAllowedHTTPMethods

public CacheSettings withAllowedHTTPMethods(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.

setCachedHTTPMethods

public void setCachedHTTPMethods(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.

getCachedHTTPMethods

public String getCachedHTTPMethods()

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:

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.

withCachedHTTPMethods

public CacheSettings withCachedHTTPMethods(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.

setForwardedCookies

public void setForwardedCookies(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.

getForwardedCookies

public CookieObject getForwardedCookies()

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

Returns:

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

withForwardedCookies

public CacheSettings withForwardedCookies(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.

setForwardedHeaders

public void setForwardedHeaders(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.

getForwardedHeaders

public HeaderObject getForwardedHeaders()

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

Returns:

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

withForwardedHeaders

public CacheSettings withForwardedHeaders(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.

setForwardedQueryStrings

public void setForwardedQueryStrings(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.

getForwardedQueryStrings

public QueryStringObject getForwardedQueryStrings()

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:

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.

withForwardedQueryStrings

public CacheSettings withForwardedQueryStrings(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CacheSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.