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

Class 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:
    Serialized Form

    • Method Detail

      • 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.

      • hashCode

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

      • equals

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

      • 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)