software.amazon.awssdk.services.cloudfront.model

Interface ForwardedValues.Builder

All Superinterfaces:

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

Enclosing class:

ForwardedValues

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

Method Summary

Modifier and Type	Method and Description
default ForwardedValues.Builder	cookies(Consumer<CookiePreference.Builder> cookies) A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones.
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.
default ForwardedValues.Builder	headers(Consumer<Headers.Builder> headers) A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.
ForwardedValues.Builder	headers(Headers headers) A complex type that specifies the Headers, if any, that you want CloudFront to base caching on 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.
default ForwardedValues.Builder	queryStringCacheKeys(Consumer<QueryStringCacheKeys.Builder> queryStringCacheKeys) A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
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.core.SdkPojo

sdkFields

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

copy

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

applyMutation, 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.

cookies

default ForwardedValues.Builder cookies(Consumer<CookiePreference.Builder> 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.

This is a convenience that creates an instance of the CookiePreference.Builder avoiding the need to create one manually via CookiePreference.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cookies(CookiePreference).

Parameters:

cookies - a consumer that will call methods on CookiePreference.Builder

Returns:

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

See Also:

cookies(CookiePreference)

headers

ForwardedValues.Builder headers(Headers headers)

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

Parameters:

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

Returns:

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

headers

default ForwardedValues.Builder headers(Consumer<Headers.Builder> headers)

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

This is a convenience that creates an instance of the Headers.Builder avoiding the need to create one manually via Headers.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to headers(Headers).

Parameters:

headers - a consumer that will call methods on Headers.Builder

Returns:

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

See Also:

headers(Headers)

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.

queryStringCacheKeys

default ForwardedValues.Builder queryStringCacheKeys(Consumer<QueryStringCacheKeys.Builder> queryStringCacheKeys)

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

This is a convenience that creates an instance of the QueryStringCacheKeys.Builder avoiding the need to create one manually via QueryStringCacheKeys.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryStringCacheKeys(QueryStringCacheKeys).

Parameters:

queryStringCacheKeys - a consumer that will call methods on QueryStringCacheKeys.Builder

Returns:

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

See Also:

queryStringCacheKeys(QueryStringCacheKeys)