Class OriginRequestPolicy

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

An origin request policy.

When it's attached to a cache behavior, the origin request policy 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

    • id

      public final String id()

      The unique identifier for the origin request policy.

      Returns:
      The unique identifier for the origin request policy.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time when the origin request policy was last modified.

      Returns:
      The date and time when the origin request policy was last modified.

    • originRequestPolicyConfig

      public final OriginRequestPolicyConfig originRequestPolicyConfig()

      The origin request policy configuration.

      Returns:
      The origin request policy configuration.

    • toBuilder

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

    • builder

      public static OriginRequestPolicy.Builder builder()

    • serializableBuilderClass

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