software.amazon.awssdk.services.cloudfront.model

Class CachePolicy

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.CachePolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CachePolicy.Builder,CachePolicy>

@Generated(value="software.amazon.awssdk:codegen")
public final class CachePolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CachePolicy.Builder,CachePolicy>

A cache policy.

When it’s attached to a cache behavior, the cache policy determines the following:

• The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

• The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find a valid object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CachePolicy.Builder

Method Summary

Modifier and Type	Method and Description
static CachePolicy.Builder	builder()
CachePolicyConfig	cachePolicyConfig() The cache policy configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The unique identifier for the cache policy.
Instant	lastModifiedTime() The date and time when the cache policy was last modified.
List<SdkField<?>>	sdkFields()
static Class<? extends CachePolicy.Builder>	serializableBuilderClass()
CachePolicy.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The unique identifier for the cache policy.

Returns:

The unique identifier for the cache policy.

lastModifiedTime

public final Instant lastModifiedTime()

The date and time when the cache policy was last modified.

Returns:

The date and time when the cache policy was last modified.

cachePolicyConfig

public final CachePolicyConfig cachePolicyConfig()

The cache policy configuration.

Returns:

The cache policy configuration.

toBuilder

public CachePolicy.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CachePolicy.Builder,CachePolicy>

Returns:

a builder for type T

builder

public static CachePolicy.Builder builder()

serializableBuilderClass

public static Class<? extends CachePolicy.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.