Class: Aws::CloudFront::Types::ParametersInCacheKeyAndForwardedToOrigin
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFront::Types::ParametersInCacheKeyAndForwardedToOrigin
- Defined in:
- gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb
Overview
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
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#cookies_config ⇒ Types::CachePolicyCookiesConfig
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.
-
#enable_accept_encoding_brotli ⇒ Boolean
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. -
#enable_accept_encoding_gzip ⇒ Boolean
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. -
#headers_config ⇒ Types::CachePolicyHeadersConfig
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.
-
#query_strings_config ⇒ Types::CachePolicyQueryStringsConfig
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.
Instance Attribute Details
#cookies_config ⇒ Types::CachePolicyCookiesConfig
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.
9132 9133 9134 9135 9136 9137 9138 9139 9140 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 9132 class ParametersInCacheKeyAndForwardedToOrigin < Struct.new( :enable_accept_encoding_gzip, :enable_accept_encoding_brotli, :headers_config, :cookies_config, :query_strings_config) SENSITIVE = [] include Aws::Structure end |
#enable_accept_encoding_brotli ⇒ Boolean
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 is true
and the viewer request
includes the Accept-Encoding
header, then CloudFront does the
following:
Normalizes the value of the viewer's
Accept-Encoding
headerIncludes 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 the Accept-Encoding
header in the origin request policy. CloudFront always includes the
Accept-Encoding
header in origin requests when the value of this
field is true
, so including this header in an origin request
policy has no effect.
If both of these fields are 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. In this case, you can
manually add Accept-Encoding
to the headers whitelist like any
other HTTP header.
9132 9133 9134 9135 9136 9137 9138 9139 9140 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 9132 class ParametersInCacheKeyAndForwardedToOrigin < Struct.new( :enable_accept_encoding_gzip, :enable_accept_encoding_brotli, :headers_config, :cookies_config, :query_strings_config) SENSITIVE = [] include Aws::Structure end |
#enable_accept_encoding_gzip ⇒ Boolean
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 is true
and the viewer request
includes the Accept-Encoding
header, then CloudFront does the
following:
Normalizes the value of the viewer's
Accept-Encoding
headerIncludes 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 the Accept-Encoding
header in the origin request policy. CloudFront always includes the
Accept-Encoding
header in origin requests when the value of this
field is true
, so including this header in an origin request
policy has no effect.
If both of these fields are 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. In this case, you can
manually add Accept-Encoding
to the headers whitelist like any
other HTTP header.
9132 9133 9134 9135 9136 9137 9138 9139 9140 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 9132 class ParametersInCacheKeyAndForwardedToOrigin < Struct.new( :enable_accept_encoding_gzip, :enable_accept_encoding_brotli, :headers_config, :cookies_config, :query_strings_config) SENSITIVE = [] include Aws::Structure end |
#headers_config ⇒ Types::CachePolicyHeadersConfig
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.
9132 9133 9134 9135 9136 9137 9138 9139 9140 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 9132 class ParametersInCacheKeyAndForwardedToOrigin < Struct.new( :enable_accept_encoding_gzip, :enable_accept_encoding_brotli, :headers_config, :cookies_config, :query_strings_config) SENSITIVE = [] include Aws::Structure end |
#query_strings_config ⇒ Types::CachePolicyQueryStringsConfig
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.
9132 9133 9134 9135 9136 9137 9138 9139 9140 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 9132 class ParametersInCacheKeyAndForwardedToOrigin < Struct.new( :enable_accept_encoding_gzip, :enable_accept_encoding_brotli, :headers_config, :cookies_config, :query_strings_config) SENSITIVE = [] include Aws::Structure end |