You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudFront::Types::CachePolicyQueryStringsConfig

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CachePolicyQueryStringsConfig as input to an Aws::Client method, you can use a vanilla Hash:

{
  query_string_behavior: "none", # required, accepts none, whitelist, allExcept, all
  query_strings: {
    quantity: 1, # required
    items: ["string"],
  },
}

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#query_string_behavior ⇒ String

Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:

  • none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.

  • whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

  • allExcept – All query strings in viewer requests that are not listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

  • all – All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

    Possible values:

    • none
    • whitelist
    • allExcept
    • all

Returns:

  • (String) —

    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.

#query_strings ⇒ Types::QueryStringNames

Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

Returns:

  • (Types::QueryStringNames) —

    Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin.