Class OriginRequestPolicyConfig

java.lang.Object
software.amazon.awssdk.services.cloudfront.model.OriginRequestPolicyConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OriginRequestPolicyConfig.Builder,OriginRequestPolicyConfig>
@Generated("software.amazon.awssdk:codegen") public final class OriginRequestPolicyConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OriginRequestPolicyConfig.Builder,OriginRequestPolicyConfig>

An origin request policy configuration.

This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:

  • The request body and the URL path (without the domain name) from the viewer request.

  • The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.

  • All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.

See Also:

  • Method Details

    • comment

      public final String comment()

      A comment to describe the origin request policy. The comment cannot be longer than 128 characters.

      Returns:
      A comment to describe the origin request policy. The comment cannot be longer than 128 characters.

    • name

      public final String name()

      A unique name to identify the origin request policy.

      Returns:
      A unique name to identify the origin request policy.

    • headersConfig

      public final OriginRequestPolicyHeadersConfig headersConfig()

      The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

      Returns:
      The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

    • cookiesConfig

      public final OriginRequestPolicyCookiesConfig cookiesConfig()

      The cookies from viewer requests to include in origin requests.

      Returns:
      The cookies from viewer requests to include in origin requests.

    • queryStringsConfig

      public final OriginRequestPolicyQueryStringsConfig queryStringsConfig()

      The URL query strings from viewer requests to include in origin requests.

      Returns:
      The URL query strings from viewer requests to include in origin requests.

    • toBuilder

      public OriginRequestPolicyConfig.Builder 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<OriginRequestPolicyConfig.Builder,OriginRequestPolicyConfig>
      Returns:
      a builder for type T

    • builder

      public static OriginRequestPolicyConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OriginRequestPolicyConfig.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.