@Generated(value="software.amazon.awssdk:codegen") public final class CachePolicyConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CachePolicyConfig.Builder,CachePolicyConfig>
A cache policy configuration.
This configuration 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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CachePolicyConfig.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CachePolicyConfig.Builder |
builder() |
String |
comment()
A comment to describe the cache policy.
|
Long |
defaultTTL()
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront
sends another request to the origin to see if the object has been updated.
|
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() |
Long |
maxTTL()
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another
request to the origin to see if the object has been updated.
|
Long |
minTTL()
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront
sends another request to the origin to see if the object has been updated.
|
String |
name()
A unique name to identify the cache policy.
|
ParametersInCacheKeyAndForwardedToOrigin |
parametersInCacheKeyAndForwardedToOrigin()
The HTTP headers, cookies, and URL query strings to include in the cache key.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CachePolicyConfig.Builder> |
serializableBuilderClass() |
CachePolicyConfig.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.
|
copypublic final String comment()
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
public final String name()
A unique name to identify the cache policy.
public final Long defaultTTL()
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront
sends another request to the origin to see if the object has been updated. CloudFront uses this value as the
object’s time to live (TTL) only when the origin does not send Cache-Control or
Expires headers with the object. For more information, see Managing How Long
Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more than
86400 seconds, then the default value for this field is the same as the value of MinTTL.
Cache-Control or Expires headers with the object. For more information, see Managing How
Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 86400 seconds (one day). If the value of MinTTL is more
than 86400 seconds, then the default value for this field is the same as the value of MinTTL.
public final Long maxTTL()
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another
request to the origin to see if the object has been updated. CloudFront uses this value only when the origin
sends Cache-Control or Expires headers with the object. For more information, see Managing How Long
Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or
DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the
value of DefaultTTL.
Cache-Control or Expires headers with the object. For more
information, see Managing How
Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
The default value for this field is 31536000 seconds (one year). If the value of MinTTL or
DefaultTTL is more than 31536000 seconds, then the default value for this field is the same
as the value of DefaultTTL.
public final Long minTTL()
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
public final ParametersInCacheKeyAndForwardedToOrigin parametersInCacheKeyAndForwardedToOrigin()
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are automatically included in requests that CloudFront sends to the origin.
public CachePolicyConfig.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CachePolicyConfig.Builder,CachePolicyConfig>public static CachePolicyConfig.Builder builder()
public static Class<? extends CachePolicyConfig.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()