CachePolicy.Builder

java.lang.Object
- software.amazon.awscdk.services.cloudfront.CachePolicy.Builder

Enclosing class:: CachePolicy

public static final class CachePolicy.Builder
extends java.lang.Object

A fluent builder for CachePolicy.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CachePolicy`	`build()`
`CachePolicy.Builder`	`cachePolicyName(java.lang.String cachePolicyName)` A unique name to identify the cache policy.
`CachePolicy.Builder`	`comment(java.lang.String comment)` A comment to describe the cache policy.
`CachePolicy.Builder`	`cookieBehavior(CacheCookieBehavior cookieBehavior)` Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`static CachePolicy.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`CachePolicy.Builder`	`defaultTtl(Duration defaultTtl)` The default amount of time for objects to stay in the CloudFront cache.
`CachePolicy.Builder`	`enableAcceptEncodingBrotli(java.lang.Boolean enableAcceptEncodingBrotli)` Whether to normalize and include the `Accept-Encoding` header in the cache key when the `Accept-Encoding` header is 'br'.
`CachePolicy.Builder`	`enableAcceptEncodingGzip(java.lang.Boolean enableAcceptEncodingGzip)` Whether to normalize and include the `Accept-Encoding` header in the cache key when the `Accept-Encoding` header is 'gzip'.
`CachePolicy.Builder`	`headerBehavior(CacheHeaderBehavior headerBehavior)` Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`CachePolicy.Builder`	`maxTtl(Duration maxTtl)` The maximum amount of time for objects to stay in the CloudFront cache.
`CachePolicy.Builder`	`minTtl(Duration minTtl)` The minimum amount of time for objects to stay in the CloudFront cache.
`CachePolicy.Builder`	`queryStringBehavior(CacheQueryStringBehavior queryStringBehavior)` Determines whether any query strings are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static CachePolicy.Builder create(software.constructs.Construct scope,
                                         java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of CachePolicy.Builder.
  - cachePolicyName
```
public CachePolicy.Builder cachePolicyName(java.lang.String cachePolicyName)
```
    A unique name to identify the cache policy.
    The name must only include '-', '_', or alphanumeric characters.
    Default: - generated from the `id`
    
    Parameters:
    
    cachePolicyName - A unique name to identify the cache policy. This parameter is required.
    
    Returns:
    
    this
  - comment
```
public CachePolicy.Builder comment(java.lang.String comment)
```
    A comment to describe the cache policy.
    Default: - no comment
    
    Parameters:
    
    comment - A comment to describe the cache policy. This parameter is required.
    
    Returns:
    
    this
  - cookieBehavior
```
public CachePolicy.Builder cookieBehavior(CacheCookieBehavior cookieBehavior)
```
    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    Default: CacheCookieBehavior.none()
    
    Parameters:
    
    cookieBehavior - Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. This parameter is required.
    
    Returns:
    
    this
  - defaultTtl
```
public CachePolicy.Builder defaultTtl(Duration defaultTtl)
```
    The default amount of time for objects to stay in the CloudFront cache.
    Only used when the origin does not send Cache-Control or Expires headers with the object.
    Default: - The greater of 1 day and ``minTtl``
    
    Parameters:
    
    defaultTtl - The default amount of time for objects to stay in the CloudFront cache. This parameter is required.
    
    Returns:
    
    this
  - enableAcceptEncodingBrotli
```
public CachePolicy.Builder enableAcceptEncodingBrotli(java.lang.Boolean enableAcceptEncodingBrotli)
```
    Whether to normalize and include the `Accept-Encoding` header in the cache key when the `Accept-Encoding` header is 'br'.
    Default: false
    
    Parameters:
    
    enableAcceptEncodingBrotli - Whether to normalize and include the `Accept-Encoding` header in the cache key when the `Accept-Encoding` header is 'br'. This parameter is required.
    
    Returns:
    
    this
  - enableAcceptEncodingGzip
```
public CachePolicy.Builder enableAcceptEncodingGzip(java.lang.Boolean enableAcceptEncodingGzip)
```
    Whether to normalize and include the `Accept-Encoding` header in the cache key when the `Accept-Encoding` header is 'gzip'.
    Default: false
    
    Parameters:
    
    enableAcceptEncodingGzip - Whether to normalize and include the `Accept-Encoding` header in the cache key when the `Accept-Encoding` header is 'gzip'. This parameter is required.
    
    Returns:
    
    this
  - headerBehavior
```
public CachePolicy.Builder headerBehavior(CacheHeaderBehavior headerBehavior)
```
    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    Default: CacheHeaderBehavior.none()
    
    Parameters:
    
    headerBehavior - Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. This parameter is required.
    
    Returns:
    
    this
  - maxTtl
```
public CachePolicy.Builder maxTtl(Duration maxTtl)
```
    The maximum amount of time for objects to stay in the CloudFront cache.
    CloudFront uses this value only when the origin sends Cache-Control or Expires headers with the object.
    Default: - The greater of 1 year and ``defaultTtl``
    
    Parameters:
    
    maxTtl - The maximum amount of time for objects to stay in the CloudFront cache. This parameter is required.
    
    Returns:
    
    this
  - minTtl
```
public CachePolicy.Builder minTtl(Duration minTtl)
```
    The minimum amount of time for objects to stay in the CloudFront cache.
    Default: Duration.seconds(0)
    
    Parameters:
    
    minTtl - The minimum amount of time for objects to stay in the CloudFront cache. This parameter is required.
    
    Returns:
    
    this
  - queryStringBehavior
```
public CachePolicy.Builder queryStringBehavior(CacheQueryStringBehavior queryStringBehavior)
```
    Determines whether any query strings are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    Default: CacheQueryStringBehavior.none()
    
    Parameters:
    
    queryStringBehavior - Determines whether any query strings are included in the cache key and automatically included in requests that CloudFront sends to the origin. This parameter is required.
    
    Returns:
    
    this
  - build
```
public CachePolicy build()
```

Class CachePolicy.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

cachePolicyName

comment

cookieBehavior

defaultTtl

enableAcceptEncodingBrotli

enableAcceptEncodingGzip

headerBehavior

maxTtl

minTtl

queryStringBehavior

build