Package software.amazon.awssdk.services.cloudfront.model

Interface ForwardedValues.Builder

All Superinterfaces:

CopyableBuilder<ForwardedValues.Builder,ForwardedValues>, SdkBuilder<ForwardedValues.Builder,ForwardedValues>

Enclosing class:

ForwardedValues

public static interface ForwardedValues.Builder
extends CopyableBuilder<ForwardedValues.Builder,ForwardedValues>

Method Summary

Modifier and Type	Method	Description
ForwardedValues.Builder	cookies(CookiePreference cookies)	A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones.
ForwardedValues.Builder	headers(Headers headers)	A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.
ForwardedValues.Builder	queryString(Boolean queryString)	Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters.
ForwardedValues.Builder	queryStringCacheKeys(QueryStringCacheKeys queryStringCacheKeys)	A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

queryString

ForwardedValues.Builder queryString(Boolean queryString)

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

Parameters:

queryString - Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

cookies

ForwardedValues.Builder cookies(CookiePreference cookies)

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

Parameters:

cookies - A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

headers

ForwardedValues.Builder headers(Headers headers)

A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.

Parameters:

headers - A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.

Returns:

Returns a reference to this object so that method calls can be chained together.

queryStringCacheKeys

ForwardedValues.Builder queryStringCacheKeys(QueryStringCacheKeys queryStringCacheKeys)

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

Parameters:

queryStringCacheKeys - A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

Returns:

Returns a reference to this object so that method calls can be chained together.