class Aws::CloudFront::Types::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 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 `OriginRequestPolicy`.

@note When making an API call, you may pass ParametersInCacheKeyAndForwardedToOrigin

data as a hash:

    {
      enable_accept_encoding_gzip: false, # required
      enable_accept_encoding_brotli: false,
      headers_config: { # required
        header_behavior: "none", # required, accepts none, whitelist
        headers: {
          quantity: 1, # required
          items: ["string"],
        },
      },
      cookies_config: { # required
        cookie_behavior: "none", # required, accepts none, whitelist, allExcept, all
        cookies: {
          quantity: 1, # required
          items: ["string"],
        },
      },
      query_strings_config: { # required
        query_string_behavior: "none", # required, accepts none, whitelist, allExcept, all
        query_strings: {
          quantity: 1, # required
          items: ["string"],
        },
      },
    }

@!attribute [rw] enable_accept_encoding_gzip

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` 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][1] 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.

[1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects
@return [Boolean]

@!attribute [rw] enable_accept_encoding_brotli

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` 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][1] 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.

[1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects
@return [Boolean]

@!attribute [rw] headers_config

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.
@return [Types::CachePolicyHeadersConfig]

@!attribute [rw] cookies_config

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.
@return [Types::CachePolicyCookiesConfig]

@!attribute [rw] query_strings_config

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.
@return [Types::CachePolicyQueryStringsConfig]

@see docs.aws.amazon.com/goto/WebAPI/cloudfront-2020-05-31/ParametersInCacheKeyAndForwardedToOrigin AWS API Documentation

Constants

SENSITIVE