software.amazon.awscdk.services.cloudfront

Class CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder

Enclosing interface:

CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty

public static final class CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder
extends java.lang.Object

A builder for CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty	build() Builds the configured instance.
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	cookiesConfig(CfnCachePolicy.CookiesConfigProperty cookiesConfig) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getCookiesConfig()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	cookiesConfig(IResolvable cookiesConfig) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getCookiesConfig()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	enableAcceptEncodingBrotli(java.lang.Boolean enableAcceptEncodingBrotli) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingBrotli()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	enableAcceptEncodingBrotli(IResolvable enableAcceptEncodingBrotli) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingBrotli()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	enableAcceptEncodingGzip(java.lang.Boolean enableAcceptEncodingGzip) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingGzip()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	enableAcceptEncodingGzip(IResolvable enableAcceptEncodingGzip) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingGzip()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	headersConfig(CfnCachePolicy.HeadersConfigProperty headersConfig) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getHeadersConfig()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	headersConfig(IResolvable headersConfig) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getHeadersConfig()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	queryStringsConfig(CfnCachePolicy.QueryStringsConfigProperty queryStringsConfig) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getQueryStringsConfig()
CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder	queryStringsConfig(IResolvable queryStringsConfig) Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getQueryStringsConfig()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cookiesConfig

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder cookiesConfig(IResolvable cookiesConfig)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getCookiesConfig()

Parameters:

cookiesConfig - An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. This parameter is required.

Returns:

this

cookiesConfig

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder cookiesConfig(CfnCachePolicy.CookiesConfigProperty cookiesConfig)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getCookiesConfig()

Parameters:

cookiesConfig - An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin. This parameter is required.

Returns:

this

enableAcceptEncodingGzip

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder enableAcceptEncodingGzip(java.lang.Boolean enableAcceptEncodingGzip)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingGzip()

Parameters:

enableAcceptEncodingGzip - A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. This parameter is required. This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

• Normalizes the value of the viewer’s Accept-Encoding header
• Includes the normalized header in the cache key
• Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide .

If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Returns:

this

enableAcceptEncodingGzip

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder enableAcceptEncodingGzip(IResolvable enableAcceptEncodingGzip)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingGzip()

Parameters:

enableAcceptEncodingGzip - A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. This parameter is required. This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

• Normalizes the value of the viewer’s Accept-Encoding header
• Includes the normalized header in the cache key
• Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide .

If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Returns:

this

headersConfig

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder headersConfig(IResolvable headersConfig)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getHeadersConfig()

Parameters:

headersConfig - An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. This parameter is required.

Returns:

this

headersConfig

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder headersConfig(CfnCachePolicy.HeadersConfigProperty headersConfig)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getHeadersConfig()

Parameters:

headersConfig - An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin. This parameter is required.

Returns:

this

queryStringsConfig

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder queryStringsConfig(IResolvable queryStringsConfig)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getQueryStringsConfig()

Parameters:

queryStringsConfig - An object that determines whether any URL query strings in viewer requests (and if so, which 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

queryStringsConfig

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder queryStringsConfig(CfnCachePolicy.QueryStringsConfigProperty queryStringsConfig)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getQueryStringsConfig()

Parameters:

queryStringsConfig - An object that determines whether any URL query strings in viewer requests (and if so, which 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

enableAcceptEncodingBrotli

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder enableAcceptEncodingBrotli(java.lang.Boolean enableAcceptEncodingBrotli)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingBrotli()

Parameters:

enableAcceptEncodingBrotli - A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

• Normalizes the value of the viewer’s Accept-Encoding header
• Includes the normalized header in the cache key
• Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide .

If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Returns:

this

enableAcceptEncodingBrotli

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.Builder enableAcceptEncodingBrotli(IResolvable enableAcceptEncodingBrotli)

Sets the value of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty.getEnableAcceptEncodingBrotli()

Parameters:

enableAcceptEncodingBrotli - A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin. This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

• Normalizes the value of the viewer’s Accept-Encoding header
• Includes the normalized header in the cache key
• Includes the normalized header in the request to the origin, if a request is necessary

For more information, see Compression support in the Amazon CloudFront Developer Guide .

If you set this value to true , and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true , so including this header in an origin request policy has no effect.

If both of these fields are false , then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

Returns:

this

build

public CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty build()

Builds the configured instance.

Returns:

a new instance of CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided