AWS::CloudFront::CachePolicy ParametersInCacheKeyAndForwardedToOrigin
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 also 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
OriginRequestPolicy
.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CookiesConfig" :
CookiesConfig
, "EnableAcceptEncodingBrotli" :Boolean
, "EnableAcceptEncodingGzip" :Boolean
, "HeadersConfig" :HeadersConfig
, "QueryStringsConfig" :QueryStringsConfig
}
YAML
CookiesConfig:
CookiesConfig
EnableAcceptEncodingBrotli:Boolean
EnableAcceptEncodingGzip:Boolean
HeadersConfig:HeadersConfig
QueryStringsConfig:QueryStringsConfig
Properties
-
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
Required: Yes
Type: CookiesConfig
Update requires: No interruption
EnableAcceptEncodingBrotli
-
A flag that can affect whether the
Accept-Encoding
HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.This field is related to the
EnableAcceptEncodingGzip
field. If one or both of these fields istrue
and the viewer request includes theAccept-Encoding
header, then CloudFront does the following:-
Normalizes the value of the viewer's
Accept-Encoding
header -
Includes the normalized header in the cache key
-
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to
true
, and this cache behavior also has an origin request policy attached, do not include theAccept-Encoding
header in the origin request policy. CloudFront always includes theAccept-Encoding
header in origin requests when the value of this field istrue
, so including this header in an origin request policy has no effect.If both of these fields are
false
, then CloudFront treats theAccept-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. In this case, you can manually addAccept-Encoding
to the headers whitelist like any other HTTP header.Required: No
Type: Boolean
Update requires: No interruption
-
EnableAcceptEncodingGzip
-
A flag that can affect whether the
Accept-Encoding
HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.This field is related to the
EnableAcceptEncodingBrotli
field. If one or both of these fields istrue
and the viewer request includes theAccept-Encoding
header, then CloudFront does the following:-
Normalizes the value of the viewer's
Accept-Encoding
header -
Includes the normalized header in the cache key
-
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to
true
, and this cache behavior also has an origin request policy attached, do not include theAccept-Encoding
header in the origin request policy. CloudFront always includes theAccept-Encoding
header in origin requests when the value of this field istrue
, so including this header in an origin request policy has no effect.If both of these fields are
false
, then CloudFront treats theAccept-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. In this case, you can manually addAccept-Encoding
to the headers whitelist like any other HTTP header.Required: Yes
Type: Boolean
Update requires: No interruption
-
HeadersConfig
-
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
Required: Yes
Type: HeadersConfig
Update requires: No interruption
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 in requests that CloudFront sends to the origin.
Required: Yes
Type: QueryStringsConfig
Update requires: No interruption