Class OriginRequestPolicyCookiesConfig

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

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

See Also:

  • Method Details

    • cookieBehavior

      public final OriginRequestPolicyCookieBehavior cookieBehavior()

      Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

      • none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.

      • whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

      • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

      • allExcept – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

      If the service returns an enum value that is not available in the current SDK version, cookieBehavior will return OriginRequestPolicyCookieBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cookieBehaviorAsString().

      Returns:
      Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

      • none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.

      • whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

      • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

      • allExcept – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

      See Also:

    • cookieBehaviorAsString

      public final String cookieBehaviorAsString()

      Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

      • none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.

      • whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

      • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

      • allExcept – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

      If the service returns an enum value that is not available in the current SDK version, cookieBehavior will return OriginRequestPolicyCookieBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cookieBehaviorAsString().

      Returns:
      Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

      • none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.

      • whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

      • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

      • allExcept – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

      See Also:

    • cookies

      public final CookieNames cookies()
      Returns the value of the Cookies property for this object.
      Returns:
      The value of the Cookies property for this object.

    • toBuilder

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

    • builder

      public static OriginRequestPolicyCookiesConfig.Builder builder()

    • serializableBuilderClass

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