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

Class: Aws::CloudFront::Types::CachePolicyCookiesConfig

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

Overview

Note:

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

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

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

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

  • none – Cookies 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 cookies that are listed in an OriginRequestPolicy are included in origin requests.

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

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

  • all – All cookies 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 cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.

#cookiesTypes::CookieNames

Contains a list of cookie names.

Returns: