CachePolicyConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.cloudfront.model

Class CachePolicyConfig

java.lang.Object
- com.amazonaws.services.cloudfront.model.CachePolicyConfig

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CachePolicyConfig
extends Object
implements Serializable, Cloneable 
```
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 also 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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CachePolicyConfig ()

Constructors
Constructor and Description
`CachePolicyConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CachePolicyConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getComment ()` A comment to describe the cache policy.
`Long`	`getDefaultTTL ()` 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.
`Long`	`getMaxTTL ()` 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`	`getMinTTL ()` 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`	`getName ()` A unique name to identify the cache policy.
`ParametersInCacheKeyAndForwardedToOrigin`	`getParametersInCacheKeyAndForwardedToOrigin ()` The HTTP headers, cookies, and URL query strings to include in the cache key.
`int`	`hashCode ()`
`void`	`setComment (String comment)` A comment to describe the cache policy.
`void`	`setDefaultTTL (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.
`void`	`setMaxTTL (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.
`void`	`setMinTTL (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.
`void`	`setName (String name)` A unique name to identify the cache policy.
`void`	`setParametersInCacheKeyAndForwardedToOrigin (ParametersInCacheKeyAndForwardedToOrigin parametersInCacheKeyAndForwardedToOrigin)` The HTTP headers, cookies, and URL query strings to include in the cache key.
`String`	`toString ()` Returns a string representation of this object.
`CachePolicyConfig`	`withComment (String comment)` A comment to describe the cache policy.
`CachePolicyConfig`	`withDefaultTTL (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.
`CachePolicyConfig`	`withMaxTTL (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.
`CachePolicyConfig`	`withMinTTL (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.
`CachePolicyConfig`	`withName (String name)` A unique name to identify the cache policy.
`CachePolicyConfig`	`withParametersInCacheKeyAndForwardedToOrigin (ParametersInCacheKeyAndForwardedToOrigin parametersInCacheKeyAndForwardedToOrigin)` The HTTP headers, cookies, and URL query strings to include in the cache key.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CachePolicyConfig
```
public CachePolicyConfig()
```
- Method Detail
  - setComment
```
public void setComment(String comment)
```
    A comment to describe the cache policy. The comment cannot be longer than 128 characters.
    
    Parameters:
    
    comment - A comment to describe the cache policy. The comment cannot be longer than 128 characters.
  - getComment
```
public String getComment()
```
    A comment to describe the cache policy. The comment cannot be longer than 128 characters.
    
    Returns:
    
    A comment to describe the cache policy. The comment cannot be longer than 128 characters.
  - withComment
```
public CachePolicyConfig withComment(String comment)
```
    A comment to describe the cache policy. The comment cannot be longer than 128 characters.
    
    Parameters:
    
    comment - A comment to describe the cache policy. The comment cannot be longer than 128 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A unique name to identify the cache policy.
    
    Parameters:
    
    name - A unique name to identify the cache policy.
  - getName
```
public String getName()
```
    A unique name to identify the cache policy.
    
    Returns:
    
    A unique name to identify the cache policy.
  - withName
```
public CachePolicyConfig withName(String name)
```
    A unique name to identify the cache policy.
    
    Parameters:
    
    name - A unique name to identify the cache policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultTTL
```
public void setDefaultTTL(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.
    
    Parameters:
    
    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.
  - getDefaultTTL
```
public Long getDefaultTTL()
```
    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.
    
    Returns:
    
    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.
  - withDefaultTTL
```
public CachePolicyConfig withDefaultTTL(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxTTL
```
public void setMaxTTL(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.
    
    Parameters:
    
    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.
  - getMaxTTL
```
public Long getMaxTTL()
```
    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.
    
    Returns:
    
    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.
  - withMaxTTL
```
public CachePolicyConfig withMaxTTL(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinTTL
```
public void setMinTTL(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.
    
    Parameters:
    
    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.
  - getMinTTL
```
public Long getMinTTL()
```
    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.
    
    Returns:
    
    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.
  - withMinTTL
```
public CachePolicyConfig withMinTTL(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParametersInCacheKeyAndForwardedToOrigin
```
public void setParametersInCacheKeyAndForwardedToOrigin(ParametersInCacheKeyAndForwardedToOrigin parametersInCacheKeyAndForwardedToOrigin)
```
    The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
    
    Parameters:
    
    parametersInCacheKeyAndForwardedToOrigin - The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
  - getParametersInCacheKeyAndForwardedToOrigin
```
public ParametersInCacheKeyAndForwardedToOrigin getParametersInCacheKeyAndForwardedToOrigin()
```
    The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
    
    Returns:
    
    The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
  - withParametersInCacheKeyAndForwardedToOrigin
```
public CachePolicyConfig withParametersInCacheKeyAndForwardedToOrigin(ParametersInCacheKeyAndForwardedToOrigin parametersInCacheKeyAndForwardedToOrigin)
```
    The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
    
    Parameters:
    
    parametersInCacheKeyAndForwardedToOrigin - The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
    
    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 CachePolicyConfig clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CachePolicyConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CachePolicyConfig

Method Detail

setComment

getComment

withComment

setName

getName

withName

setDefaultTTL

getDefaultTTL

withDefaultTTL

setMaxTTL

getMaxTTL

withMaxTTL

setMinTTL

getMinTTL

withMinTTL

setParametersInCacheKeyAndForwardedToOrigin

getParametersInCacheKeyAndForwardedToOrigin

withParametersInCacheKeyAndForwardedToOrigin

toString

equals

hashCode

clone