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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OriginRequestPolicyCookiesConfig.Builder

Method Summary

Modifier and Type	Method	Description
static OriginRequestPolicyCookiesConfig.Builder	builder()
OriginRequestPolicyCookieBehavior	cookieBehavior()	Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin.
String	cookieBehaviorAsString()	Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin.
CookieNames	cookies()	Returns the value of the Cookies property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends OriginRequestPolicyCookiesConfig.Builder>	serializableBuilderClass()
OriginRequestPolicyCookiesConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

OriginRequestPolicyCookieBehavior

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:

OriginRequestPolicyCookieBehavior

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

Specified by:

toBuilder in interface ToCopyableBuilder<OriginRequestPolicyCookiesConfig.Builder,OriginRequestPolicyCookiesConfig>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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