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

Class: Aws::CloudFront::Types::CookiePreference

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

{
  forward: "none", # required, accepts none, whitelist, all
  whitelisted_names: {
    quantity: 1, # required
    items: ["string"],
  },
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#forwardString

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

Returns:

  • (String)


815
816
817
818
819
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 815

class CookiePreference < Struct.new(
  :forward,
  :whitelisted_names)
  include Aws::Structure
end

#whitelisted_namesTypes::CookieNames

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

Returns:



815
816
817
818
819
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/types.rb', line 815

class CookiePreference < Struct.new(
  :forward,
  :whitelisted_names)
  include Aws::Structure
end