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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OriginRequestPolicy.Builder

Method Summary

Modifier and Type	Method	Description
static OriginRequestPolicy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique identifier for the origin request policy.
Instant	lastModifiedTime()	The date and time when the origin request policy was last modified.
OriginRequestPolicyConfig	originRequestPolicyConfig()	The origin request policy configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends OriginRequestPolicy.Builder>	serializableBuilderClass()
OriginRequestPolicy.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

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

Specified by:

toBuilder in interface ToCopyableBuilder<OriginRequestPolicy.Builder,OriginRequestPolicy>

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo