Package software.amazon.awscdk.services.cloudfront

Class CachePolicyProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.CachePolicyProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CachePolicyProps>

Enclosing interface:

CachePolicyProps

@Stability(Stable)
public static final class CachePolicyProps.Builder
extends Object
implements software.amazon.jsii.Builder<CachePolicyProps>

A builder for CachePolicyProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CachePolicyProps	build()	Builds the configured instance.
CachePolicyProps.Builder	cachePolicyName(String cachePolicyName)	Sets the value of CachePolicyProps.getCachePolicyName()
CachePolicyProps.Builder	comment(String comment)	Sets the value of CachePolicyProps.getComment()
CachePolicyProps.Builder	cookieBehavior(CacheCookieBehavior cookieBehavior)	Sets the value of CachePolicyProps.getCookieBehavior()
CachePolicyProps.Builder	defaultTtl(Duration defaultTtl)	Sets the value of CachePolicyProps.getDefaultTtl()
CachePolicyProps.Builder	enableAcceptEncodingBrotli(Boolean enableAcceptEncodingBrotli)	Sets the value of CachePolicyProps.getEnableAcceptEncodingBrotli()
CachePolicyProps.Builder	enableAcceptEncodingGzip(Boolean enableAcceptEncodingGzip)	Sets the value of CachePolicyProps.getEnableAcceptEncodingGzip()
CachePolicyProps.Builder	headerBehavior(CacheHeaderBehavior headerBehavior)	Sets the value of CachePolicyProps.getHeaderBehavior()
CachePolicyProps.Builder	maxTtl(Duration maxTtl)	Sets the value of CachePolicyProps.getMaxTtl()
CachePolicyProps.Builder	minTtl(Duration minTtl)	Sets the value of CachePolicyProps.getMinTtl()
CachePolicyProps.Builder	queryStringBehavior(CacheQueryStringBehavior queryStringBehavior)	Sets the value of CachePolicyProps.getQueryStringBehavior()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

cachePolicyName

@Stability(Stable)
public CachePolicyProps.Builder cachePolicyName(String cachePolicyName)

Sets the value of CachePolicyProps.getCachePolicyName()

Parameters:

cachePolicyName - A unique name to identify the cache policy. The name must only include '-', '_', or alphanumeric characters.

Returns:

this

comment

@Stability(Stable)
public CachePolicyProps.Builder comment(String comment)

Sets the value of CachePolicyProps.getComment()

Parameters:

comment - A comment to describe the cache policy. The comment cannot be longer than 128 characters.

Returns:

this

cookieBehavior

@Stability(Stable)
public CachePolicyProps.Builder cookieBehavior(CacheCookieBehavior cookieBehavior)

Sets the value of CachePolicyProps.getCookieBehavior()

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.

Returns:

this

defaultTtl

@Stability(Stable)
public CachePolicyProps.Builder defaultTtl(Duration defaultTtl)

Sets the value of CachePolicyProps.getDefaultTtl()

Parameters:

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.

Returns:

this

enableAcceptEncodingBrotli

@Stability(Stable)
public CachePolicyProps.Builder enableAcceptEncodingBrotli(Boolean enableAcceptEncodingBrotli)

Sets the value of CachePolicyProps.getEnableAcceptEncodingBrotli()

Parameters:

enableAcceptEncodingBrotli - Whether to normalize and include the Accept-Encoding header in the cache key when the Accept-Encoding header is 'br'.

Returns:

this

enableAcceptEncodingGzip

@Stability(Stable)
public CachePolicyProps.Builder enableAcceptEncodingGzip(Boolean enableAcceptEncodingGzip)

Sets the value of CachePolicyProps.getEnableAcceptEncodingGzip()

Parameters:

enableAcceptEncodingGzip - Whether to normalize and include the Accept-Encoding header in the cache key when the Accept-Encoding header is 'gzip'.

Returns:

this

headerBehavior

@Stability(Stable)
public CachePolicyProps.Builder headerBehavior(CacheHeaderBehavior headerBehavior)

Sets the value of CachePolicyProps.getHeaderBehavior()

Parameters:

headerBehavior - Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Returns:

this

maxTtl

@Stability(Stable)
public CachePolicyProps.Builder maxTtl(Duration maxTtl)

Sets the value of CachePolicyProps.getMaxTtl()

Parameters:

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.

Returns:

this

minTtl

@Stability(Stable)
public CachePolicyProps.Builder minTtl(Duration minTtl)

Sets the value of CachePolicyProps.getMinTtl()

Parameters:

minTtl - The minimum amount of time for objects to stay in the CloudFront cache.

Returns:

this

queryStringBehavior

@Stability(Stable)
public CachePolicyProps.Builder queryStringBehavior(CacheQueryStringBehavior queryStringBehavior)

Sets the value of CachePolicyProps.getQueryStringBehavior()

Parameters:

queryStringBehavior - Determines whether any query strings are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Returns:

this

build

@Stability(Stable)
public CachePolicyProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CachePolicyProps>

Returns:

a new instance of CachePolicyProps

Throws:

NullPointerException - if any required attribute was not provided