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

Interface ParametersInCacheKeyAndForwardedToOrigin.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ParametersInCacheKeyAndForwardedToOrigin.Builder,ParametersInCacheKeyAndForwardedToOrigin>, SdkBuilder<ParametersInCacheKeyAndForwardedToOrigin.Builder,ParametersInCacheKeyAndForwardedToOrigin>, SdkPojo
Enclosing class:
ParametersInCacheKeyAndForwardedToOrigin
public static interface ParametersInCacheKeyAndForwardedToOrigin.Builder extends SdkPojo, CopyableBuilder<ParametersInCacheKeyAndForwardedToOrigin.Builder,ParametersInCacheKeyAndForwardedToOrigin>

  • Method Details

    • enableAcceptEncodingGzip

      ParametersInCacheKeyAndForwardedToOrigin.Builder enableAcceptEncodingGzip(Boolean 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 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.

      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 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:
      Returns a reference to this object so that method calls can be chained together.

    • enableAcceptEncodingBrotli

      ParametersInCacheKeyAndForwardedToOrigin.Builder enableAcceptEncodingBrotli(Boolean 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.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • headersConfig

      ParametersInCacheKeyAndForwardedToOrigin.Builder headersConfig(CachePolicyHeadersConfig headersConfig)

      An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.

      Parameters:
      headersConfig - An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headersConfig

      default ParametersInCacheKeyAndForwardedToOrigin.Builder headersConfig(Consumer<CachePolicyHeadersConfig.Builder> headersConfig)

      An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.

      This is a convenience method that creates an instance of the CachePolicyHeadersConfig.Builder avoiding the need to create one manually via CachePolicyHeadersConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to headersConfig(CachePolicyHeadersConfig).

      Parameters:
      headersConfig - a consumer that will call methods on CachePolicyHeadersConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cookiesConfig

      ParametersInCacheKeyAndForwardedToOrigin.Builder cookiesConfig(CachePolicyCookiesConfig cookiesConfig)

      An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.

      Parameters:
      cookiesConfig - An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cookiesConfig

      default ParametersInCacheKeyAndForwardedToOrigin.Builder cookiesConfig(Consumer<CachePolicyCookiesConfig.Builder> cookiesConfig)

      An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.

      This is a convenience method that creates an instance of the CachePolicyCookiesConfig.Builder avoiding the need to create one manually via CachePolicyCookiesConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cookiesConfig(CachePolicyCookiesConfig).

      Parameters:
      cookiesConfig - a consumer that will call methods on CachePolicyCookiesConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryStringsConfig

      ParametersInCacheKeyAndForwardedToOrigin.Builder queryStringsConfig(CachePolicyQueryStringsConfig 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 in requests that CloudFront sends to the origin.

      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 in requests that CloudFront sends to the origin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryStringsConfig

      default ParametersInCacheKeyAndForwardedToOrigin.Builder queryStringsConfig(Consumer<CachePolicyQueryStringsConfig.Builder> 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 in requests that CloudFront sends to the origin.

      This is a convenience method that creates an instance of the CachePolicyQueryStringsConfig.Builder avoiding the need to create one manually via CachePolicyQueryStringsConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryStringsConfig(CachePolicyQueryStringsConfig).

      Parameters:
      queryStringsConfig - a consumer that will call methods on CachePolicyQueryStringsConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: