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"],
  },
}

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use `CookiesConfig` in a cache policy. See `CachePolicy`.

If you want to send cookies to the origin but not include them in the cache key, use `CookiesConfig` in an origin request policy. See `OriginRequestPolicy`.

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 [Caching Content Based on Cookies] in the *Amazon CloudFront Developer Guide*.

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#forwardString

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies] in the *Amazon CloudFront Developer Guide*.

If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see

Creating origin request policies][2

in the *Amazon CloudFront

Developer Guide*.

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.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy [2]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy

Returns:

  • (String)

1779
1780
1781
1782
1783
1784
# File 'lib/aws-sdk-cloudfront/types.rb', line 1779

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

#whitelisted_namesTypes::CookieNames

This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies] in the *Amazon CloudFront Developer Guide*.

If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies] in the *Amazon CloudFront Developer Guide*.

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 [ CloudFront Limits] in the *Amazon Web Services General Reference*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy [2]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy [3]: docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront

Returns:


1779
1780
1781
1782
1783
1784
# File 'lib/aws-sdk-cloudfront/types.rb', line 1779

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