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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#forward ⇒ String

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) 


936
937
938
939
940
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 936

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

#whitelisted_names ⇒ Types::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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront

Returns:



936
937
938
939
940
 
# File 'lib/aws-sdk-cloudfront/types.rb', line 936

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