OriginRequestPolicyConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.cloudfront.model

Class OriginRequestPolicyConfig

java.lang.Object
- com.amazonaws.services.cloudfront.model.OriginRequestPolicyConfig

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OriginRequestPolicyConfig
extends Object
implements Serializable, Cloneable 
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OriginRequestPolicyConfig ()

Constructors
Constructor and Description
`OriginRequestPolicyConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`OriginRequestPolicyConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getComment ()` A comment to describe the origin request policy.
`OriginRequestPolicyCookiesConfig`	`getCookiesConfig ()` The cookies from viewer requests to include in origin requests.
`OriginRequestPolicyHeadersConfig`	`getHeadersConfig ()` The HTTP headers to include in origin requests.
`String`	`getName ()` A unique name to identify the origin request policy.
`OriginRequestPolicyQueryStringsConfig`	`getQueryStringsConfig ()` The URL query strings from viewer requests to include in origin requests.
`int`	`hashCode ()`
`void`	`setComment (String comment)` A comment to describe the origin request policy.
`void`	`setCookiesConfig (OriginRequestPolicyCookiesConfig cookiesConfig)` The cookies from viewer requests to include in origin requests.
`void`	`setHeadersConfig (OriginRequestPolicyHeadersConfig headersConfig)` The HTTP headers to include in origin requests.
`void`	`setName (String name)` A unique name to identify the origin request policy.
`void`	`setQueryStringsConfig (OriginRequestPolicyQueryStringsConfig queryStringsConfig)` The URL query strings from viewer requests to include in origin requests.
`String`	`toString ()` Returns a string representation of this object.
`OriginRequestPolicyConfig`	`withComment (String comment)` A comment to describe the origin request policy.
`OriginRequestPolicyConfig`	`withCookiesConfig (OriginRequestPolicyCookiesConfig cookiesConfig)` The cookies from viewer requests to include in origin requests.
`OriginRequestPolicyConfig`	`withHeadersConfig (OriginRequestPolicyHeadersConfig headersConfig)` The HTTP headers to include in origin requests.
`OriginRequestPolicyConfig`	`withName (String name)` A unique name to identify the origin request policy.
`OriginRequestPolicyConfig`	`withQueryStringsConfig (OriginRequestPolicyQueryStringsConfig queryStringsConfig)` The URL query strings from viewer requests to include in origin requests.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - OriginRequestPolicyConfig
```
public OriginRequestPolicyConfig()
```
- Method Detail
  - setComment
```
public void setComment(String comment)
```
    A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
    
    Parameters:
    
    comment - A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
  - getComment
```
public String getComment()
```
    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.
  - withComment
```
public OriginRequestPolicyConfig withComment(String comment)
```
    A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
    
    Parameters:
    
    comment - A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    A unique name to identify the origin request policy.
    
    Parameters:
    
    name - A unique name to identify the origin request policy.
  - getName
```
public String getName()
```
    A unique name to identify the origin request policy.
    
    Returns:
    
    A unique name to identify the origin request policy.
  - withName
```
public OriginRequestPolicyConfig withName(String name)
```
    A unique name to identify the origin request policy.
    
    Parameters:
    
    name - A unique name to identify the origin request policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeadersConfig
```
public void setHeadersConfig(OriginRequestPolicyHeadersConfig headersConfig)
```
    The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
    
    Parameters:
    
    headersConfig - The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
  - getHeadersConfig
```
public OriginRequestPolicyHeadersConfig getHeadersConfig()
```
    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.
  - withHeadersConfig
```
public OriginRequestPolicyConfig withHeadersConfig(OriginRequestPolicyHeadersConfig headersConfig)
```
    The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
    
    Parameters:
    
    headersConfig - The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCookiesConfig
```
public void setCookiesConfig(OriginRequestPolicyCookiesConfig cookiesConfig)
```
    The cookies from viewer requests to include in origin requests.
    
    Parameters:
    
    cookiesConfig - The cookies from viewer requests to include in origin requests.
  - getCookiesConfig
```
public OriginRequestPolicyCookiesConfig getCookiesConfig()
```
    The cookies from viewer requests to include in origin requests.
    
    Returns:
    
    The cookies from viewer requests to include in origin requests.
  - withCookiesConfig
```
public OriginRequestPolicyConfig withCookiesConfig(OriginRequestPolicyCookiesConfig cookiesConfig)
```
    The cookies from viewer requests to include in origin requests.
    
    Parameters:
    
    cookiesConfig - The cookies from viewer requests to include in origin requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryStringsConfig
```
public void setQueryStringsConfig(OriginRequestPolicyQueryStringsConfig queryStringsConfig)
```
    The URL query strings from viewer requests to include in origin requests.
    
    Parameters:
    
    queryStringsConfig - The URL query strings from viewer requests to include in origin requests.
  - getQueryStringsConfig
```
public OriginRequestPolicyQueryStringsConfig getQueryStringsConfig()
```
    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.
  - withQueryStringsConfig
```
public OriginRequestPolicyConfig withQueryStringsConfig(OriginRequestPolicyQueryStringsConfig queryStringsConfig)
```
    The URL query strings from viewer requests to include in origin requests.
    
    Parameters:
    
    queryStringsConfig - The URL query strings from viewer requests to include in origin requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public OriginRequestPolicyConfig clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class OriginRequestPolicyConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OriginRequestPolicyConfig

Method Detail

setComment

getComment

withComment

setName

getName

withName

setHeadersConfig

getHeadersConfig

withHeadersConfig

setCookiesConfig

getCookiesConfig

withCookiesConfig

setQueryStringsConfig

getQueryStringsConfig

withQueryStringsConfig

toString

equals

hashCode

clone