software.amazon.awscdk.services.cloudfront

Interface CfnCachePolicy.CachePolicyConfigProperty

All Known Implementing Classes:

CfnCachePolicy.CachePolicyConfigProperty.Jsii$Proxy

Enclosing class:

CfnCachePolicy

public static interface CfnCachePolicy.CachePolicyConfigProperty

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 CachePolicyConfigProperty cachePolicyConfigProperty = CachePolicyConfigProperty.builder()
         .defaultTtl(123)
         .maxTtl(123)
         .minTtl(123)
         .name("name")
         .parametersInCacheKeyAndForwardedToOrigin(ParametersInCacheKeyAndForwardedToOriginProperty.builder()
                 .cookiesConfig(CookiesConfigProperty.builder()
                         .cookieBehavior("cookieBehavior")
                         // the properties below are optional
                         .cookies(List.of("cookies"))
                         .build())
                 .enableAcceptEncodingGzip(false)
                 .headersConfig(HeadersConfigProperty.builder()
                         .headerBehavior("headerBehavior")
                         // the properties below are optional
                         .headers(List.of("headers"))
                         .build())
                 .queryStringsConfig(QueryStringsConfigProperty.builder()
                         .queryStringBehavior("queryStringBehavior")
                         // the properties below are optional
                         .queryStrings(List.of("queryStrings"))
                         .build())
                 // the properties below are optional
                 .enableAcceptEncodingBrotli(false)
                 .build())
         // the properties below are optional
         .comment("comment")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCachePolicy.CachePolicyConfigProperty.Builder A builder for CfnCachePolicy.CachePolicyConfigProperty
static class	CfnCachePolicy.CachePolicyConfigProperty.Jsii$Proxy An implementation for CfnCachePolicy.CachePolicyConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnCachePolicy.CachePolicyConfigProperty.Builder	builder()
default java.lang.String	getComment() A comment to describe the cache policy.
java.lang.Number	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.
java.lang.Number	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.
java.lang.Number	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.
java.lang.String	getName() A unique name to identify the cache policy.
java.lang.Object	getParametersInCacheKeyAndForwardedToOrigin() The HTTP headers, cookies, and URL query strings to include in the cache key.

Method Detail

getDefaultTtl

java.lang.Number 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 .

getMaxTtl

java.lang.Number 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 .

getMinTtl

java.lang.Number 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 .

getName

java.lang.String getName()

A unique name to identify the cache policy.

getParametersInCacheKeyAndForwardedToOrigin

java.lang.Object getParametersInCacheKeyAndForwardedToOrigin()

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.

getComment

default java.lang.String getComment()

A comment to describe the cache policy.

The comment cannot be longer than 128 characters.

builder

static CfnCachePolicy.CachePolicyConfigProperty.Builder builder()

Returns:

a CfnCachePolicy.CachePolicyConfigProperty.Builder of CfnCachePolicy.CachePolicyConfigProperty