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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb

Overview

Note:

When making an API call, you may pass CachePolicyQueryStringsConfig data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#query_string_behaviorString

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.

Returns:

  • (String)


1142
1143
1144
1145
1146
1147
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 1142

class CachePolicyQueryStringsConfig < Struct.new(
  :query_string_behavior,
  :query_strings)
  SENSITIVE = []
  include Aws::Structure
end

#query_stringsTypes::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).



1142
1143
1144
1145
1146
1147
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 1142

class CachePolicyQueryStringsConfig < Struct.new(
  :query_string_behavior,
  :query_strings)
  SENSITIVE = []
  include Aws::Structure
end