Class ParametersInCacheKeyAndForwardedToOrigin

java.lang.Object
software.amazon.awssdk.services.cloudfront.model.ParametersInCacheKeyAndForwardedToOrigin
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ParametersInCacheKeyAndForwardedToOrigin.Builder,ParametersInCacheKeyAndForwardedToOrigin>

@Generated("software.amazon.awssdk:codegen") public final class ParametersInCacheKeyAndForwardedToOrigin extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParametersInCacheKeyAndForwardedToOrigin.Builder,ParametersInCacheKeyAndForwardedToOrigin>

This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

See Also:
  • Method Details

    • enableAcceptEncodingGzip

      public final 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.

      Returns:
      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.

    • enableAcceptEncodingBrotli

      public final 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.

      Returns:
      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.

    • headersConfig

      public final 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.

      Returns:
      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.
    • cookiesConfig

      public final 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.

      Returns:
      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.
    • queryStringsConfig

      public final 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.

      Returns:
      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.
    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ParametersInCacheKeyAndForwardedToOrigin.Builder,ParametersInCacheKeyAndForwardedToOrigin>
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends ParametersInCacheKeyAndForwardedToOrigin.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.