ParametersInCacheKeyAndForwardedToOrigin (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ParametersInCacheKeyAndForwardedToOrigin
extends Object
implements Serializable, Cloneable
```
This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use CreateOriginRequestPolicy.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ParametersInCacheKeyAndForwardedToOrigin()

Constructors
Constructor and Description
`ParametersInCacheKeyAndForwardedToOrigin()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParametersInCacheKeyAndForwardedToOrigin`	`clone()`
`boolean`	`equals(Object obj)`
`CachePolicyCookiesConfig`	`getCookiesConfig()` An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`Boolean`	`getEnableAcceptEncodingGzip()` A flag that determines whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
`CachePolicyHeadersConfig`	`getHeadersConfig()` An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`CachePolicyQueryStringsConfig`	`getQueryStringsConfig()` An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`int`	`hashCode()`
`Boolean`	`isEnableAcceptEncodingGzip()` A flag that determines whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
`void`	`setCookiesConfig(CachePolicyCookiesConfig cookiesConfig)` An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`void`	`setEnableAcceptEncodingGzip(Boolean enableAcceptEncodingGzip)` A flag that determines whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
`void`	`setHeadersConfig(CachePolicyHeadersConfig headersConfig)` An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`void`	`setQueryStringsConfig(CachePolicyQueryStringsConfig queryStringsConfig)` An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`String`	`toString()` Returns a string representation of this object.
`ParametersInCacheKeyAndForwardedToOrigin`	`withCookiesConfig(CachePolicyCookiesConfig cookiesConfig)` An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`ParametersInCacheKeyAndForwardedToOrigin`	`withEnableAcceptEncodingGzip(Boolean enableAcceptEncodingGzip)` A flag that determines whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
`ParametersInCacheKeyAndForwardedToOrigin`	`withHeadersConfig(CachePolicyHeadersConfig headersConfig)` An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
`ParametersInCacheKeyAndForwardedToOrigin`	`withQueryStringsConfig(CachePolicyQueryStringsConfig queryStringsConfig)` An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.

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

- Constructor Detail
  - ParametersInCacheKeyAndForwardedToOrigin
```
public ParametersInCacheKeyAndForwardedToOrigin()
```
- Method Detail
  - setEnableAcceptEncodingGzip
```
public void setEnableAcceptEncodingGzip(Boolean enableAcceptEncodingGzip)
```
    A flag that determines whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
    
    If this field is true and the viewer request includes the Accept-Encoding header, then CloudFront normalizes the value of the viewer’s Accept-Encoding header to one of the following:
    - Accept-Encoding: gzip (if gzip is in the viewer’s Accept-Encoding header)
    - Accept-Encoding: identity (if gzip is not in the viewer’s Accept-Encoding header)
    CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront sends to the origin.
    
    If this field is false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. You can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
    
    When this field is true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
    
    For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.
    Parameters:
    enableAcceptEncodingGzip - A flag that determines whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
    
    If this field is true and the viewer request includes the Accept-Encoding header, then CloudFront normalizes the value of the viewer’s Accept-Encoding header to one of the following:
    
    Accept-Encoding: gzip (if gzip is in the viewer’s Accept-Encoding header)
    
    Accept-Encoding: identity (if gzip is not in the viewer’s Accept-Encoding header)
    
    CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront sends to the origin.
    
    If this field is false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. You can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
    
    When this field is true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
    
    For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.
  - getEnableAcceptEncodingGzip
```
public Boolean getEnableAcceptEncodingGzip()
```
    A flag that determines whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
    
    If this field is true and the viewer request includes the Accept-Encoding header, then CloudFront normalizes the value of the viewer’s Accept-Encoding header to one of the following:
    - Accept-Encoding: gzip (if gzip is in the viewer’s Accept-Encoding header)
    - Accept-Encoding: identity (if gzip is not in the viewer’s Accept-Encoding header)
    CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront sends to the origin.
    
    If this field is false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. You can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
    
    When this field is true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
    
    For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.
    Returns:
    A flag that determines whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
    
    If this field is true and the viewer request includes the Accept-Encoding header, then CloudFront normalizes the value of the viewer’s Accept-Encoding header to one of the following:
    
    Accept-Encoding: gzip (if gzip is in the viewer’s Accept-Encoding header)
    
    Accept-Encoding: identity (if gzip is not in the viewer’s Accept-Encoding header)
    
    CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront sends to the origin.
    
    If this field is false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. You can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
    
    When this field is true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
    
    For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.
  - withEnableAcceptEncodingGzip
```
public ParametersInCacheKeyAndForwardedToOrigin withEnableAcceptEncodingGzip(Boolean enableAcceptEncodingGzip)
```
    A flag that determines whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
    
    If this field is true and the viewer request includes the Accept-Encoding header, then CloudFront normalizes the value of the viewer’s Accept-Encoding header to one of the following:
    - Accept-Encoding: gzip (if gzip is in the viewer’s Accept-Encoding header)
    - Accept-Encoding: identity (if gzip is not in the viewer’s Accept-Encoding header)
    CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront sends to the origin.
    
    If this field is false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. You can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
    
    When this field is true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
    
    For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.
    Parameters:
    enableAcceptEncodingGzip - A flag that determines whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
    
    If this field is true and the viewer request includes the Accept-Encoding header, then CloudFront normalizes the value of the viewer’s Accept-Encoding header to one of the following:
    
    Accept-Encoding: gzip (if gzip is in the viewer’s Accept-Encoding header)
    
    Accept-Encoding: identity (if gzip is not in the viewer’s Accept-Encoding header)
    
    CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront sends to the origin.
    
    If this field is false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. You can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
    
    When this field is true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
    
    For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableAcceptEncodingGzip
```
public Boolean isEnableAcceptEncodingGzip()
```
    A flag that determines whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
    
    If this field is true and the viewer request includes the Accept-Encoding header, then CloudFront normalizes the value of the viewer’s Accept-Encoding header to one of the following:
    - Accept-Encoding: gzip (if gzip is in the viewer’s Accept-Encoding header)
    - Accept-Encoding: identity (if gzip is not in the viewer’s Accept-Encoding header)
    CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront sends to the origin.
    
    If this field is false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. You can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
    
    When this field is true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
    
    For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.
    Returns:
    A flag that determines whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
    
    If this field is true and the viewer request includes the Accept-Encoding header, then CloudFront normalizes the value of the viewer’s Accept-Encoding header to one of the following:
    
    Accept-Encoding: gzip (if gzip is in the viewer’s Accept-Encoding header)
    
    Accept-Encoding: identity (if gzip is not in the viewer’s Accept-Encoding header)
    
    CloudFront includes the normalized header in the cache key and includes it in requests that CloudFront sends to the origin.
    
    If this field is false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. You can manually add Accept-Encoding to the headers whitelist like any other HTTP header.
    
    When this field is true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
    
    For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.
  - setHeadersConfig
```
public void setHeadersConfig(CachePolicyHeadersConfig headersConfig)
```
    An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Parameters:
    
    headersConfig - An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - getHeadersConfig
```
public CachePolicyHeadersConfig getHeadersConfig()
```
    An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Returns:
    
    An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - withHeadersConfig
```
public ParametersInCacheKeyAndForwardedToOrigin withHeadersConfig(CachePolicyHeadersConfig headersConfig)
```
    An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Parameters:
    
    headersConfig - An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCookiesConfig
```
public void setCookiesConfig(CachePolicyCookiesConfig cookiesConfig)
```
    An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Parameters:
    
    cookiesConfig - An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - getCookiesConfig
```
public CachePolicyCookiesConfig getCookiesConfig()
```
    An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Returns:
    
    An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - withCookiesConfig
```
public ParametersInCacheKeyAndForwardedToOrigin withCookiesConfig(CachePolicyCookiesConfig cookiesConfig)
```
    An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Parameters:
    
    cookiesConfig - An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryStringsConfig
```
public void setQueryStringsConfig(CachePolicyQueryStringsConfig queryStringsConfig)
```
    An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Parameters:
    
    queryStringsConfig - An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - getQueryStringsConfig
```
public CachePolicyQueryStringsConfig getQueryStringsConfig()
```
    An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Returns:
    
    An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - withQueryStringsConfig
```
public ParametersInCacheKeyAndForwardedToOrigin withQueryStringsConfig(CachePolicyQueryStringsConfig queryStringsConfig)
```
    An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    Parameters:
    
    queryStringsConfig - An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    
    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 ParametersInCacheKeyAndForwardedToOrigin clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ParametersInCacheKeyAndForwardedToOrigin

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParametersInCacheKeyAndForwardedToOrigin

Method Detail

setEnableAcceptEncodingGzip

getEnableAcceptEncodingGzip

withEnableAcceptEncodingGzip

isEnableAcceptEncodingGzip

setHeadersConfig

getHeadersConfig

withHeadersConfig

setCookiesConfig

getCookiesConfig

withCookiesConfig

setQueryStringsConfig

getQueryStringsConfig

withQueryStringsConfig

toString

equals

hashCode

clone