Interface ForwardedValues.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ForwardedValues.Builder,
,ForwardedValues> SdkBuilder<ForwardedValues.Builder,
,ForwardedValues> SdkPojo
- Enclosing class:
ForwardedValues
-
Method Summary
Modifier and TypeMethodDescriptiondefault ForwardedValues.Builder
cookies
(Consumer<CookiePreference.Builder> cookies) This field is deprecated.cookies
(CookiePreference cookies) This field is deprecated.default ForwardedValues.Builder
headers
(Consumer<Headers.Builder> headers) This field is deprecated.This field is deprecated.queryString
(Boolean queryString) This field is deprecated.default ForwardedValues.Builder
queryStringCacheKeys
(Consumer<QueryStringCacheKeys.Builder> queryStringCacheKeys) This field is deprecated.queryStringCacheKeys
(QueryStringCacheKeys queryStringCacheKeys) This field is deprecated.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
queryString
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
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 forQueryStringCacheKeys
, if any:If you specify true for
QueryString
and you don't specify any values forQueryStringCacheKeys
, 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 forQueryStringCacheKeys
, 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
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
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 forQueryStringCacheKeys
, if any:If you specify true for
QueryString
and you don't specify any values forQueryStringCacheKeys
, 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 forQueryStringCacheKeys
, 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
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
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
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
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
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
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 method that creates an instance of theCookiePreference.Builder
avoiding the need to create one manually viaCookiePreference.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocookies(CookiePreference)
.- Parameters:
cookies
- a consumer that will call methods onCookiePreference.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
headers
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.
- Parameters:
headers
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
headers
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
A complex type that specifies the
Headers
, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.
This is a convenience method that creates an instance of theHeaders.Builder
avoiding the need to create one manually viaHeaders.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toheaders(Headers)
.- Parameters:
headers
- a consumer that will call methods onHeaders.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
queryStringCacheKeys
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
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
- This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
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) This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
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 method that creates an instance of theQueryStringCacheKeys.Builder
avoiding the need to create one manually viaQueryStringCacheKeys.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toqueryStringCacheKeys(QueryStringCacheKeys)
.- Parameters:
queryStringCacheKeys
- a consumer that will call methods onQueryStringCacheKeys.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-