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

Class: Aws::CloudFront::Types::ForwardedValues

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 ForwardedValues data as a hash:

{
  query_string: false, # required
  cookies: { # required
    forward: "none", # required, accepts none, whitelist, all
    whitelisted_names: {
      quantity: 1, # required
      items: ["string"],
    },
  },
  headers: {
    quantity: 1, # required
    items: ["string"],
  },
  query_string_cache_keys: {
    quantity: 1, # required
    items: ["string"],
  },
}

A complex type that specifies how CloudFront handles query strings and cookies.

Instance Attribute Summary collapse

Instance Attribute Details

#cookiesTypes::CookiePreference

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.



3332
3333
3334
3335
3336
3337
3338
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3332

class ForwardedValues < Struct.new(
  :query_string,
  :cookies,
  :headers,
  :query_string_cache_keys)
  include Aws::Structure
end

#headersTypes::Headers

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

Returns:



3332
3333
3334
3335
3336
3337
3338
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3332

class ForwardedValues < Struct.new(
  :query_string,
  :cookies,
  :headers,
  :query_string_cache_keys)
  include Aws::Structure
end

#query_stringBoolean

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

Returns:

  • (Boolean)


3332
3333
3334
3335
3336
3337
3338
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3332

class ForwardedValues < Struct.new(
  :query_string,
  :cookies,
  :headers,
  :query_string_cache_keys)
  include Aws::Structure
end

#query_string_cache_keysTypes::QueryStringCacheKeys

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.



3332
3333
3334
3335
3336
3337
3338
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 3332

class ForwardedValues < Struct.new(
  :query_string,
  :cookies,
  :headers,
  :query_string_cache_keys)
  include Aws::Structure
end