Class: Aws::CloudFront::Types::CookieNames

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

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

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html

Instance Attribute Summary collapse

Instance Attribute Details

#itemsArray<String>

A complex type that contains one ‘Name` element for each cookie that you want CloudFront to forward to the origin for this cache behavior. It must contain the same number of items that is specified in the `Quantity` field.

When you set ‘Forward = whitelist` (in the `CookiePreferences` object), this field must contain at least one item.

Returns:

  • (Array<String>)


1002
1003
1004
1005
1006
# File 'lib/aws-sdk-cloudfront/types.rb', line 1002

class CookieNames < Struct.new(
  :quantity,
  :items)
  include Aws::Structure
end

#quantityInteger

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. The value must equal the number of items that are in the ‘Items` field.

When you set ‘Forward = whitelist` (in the `CookiePreferences` object), this value must be `1` or higher.

Returns:

  • (Integer)


1002
1003
1004
1005
1006
# File 'lib/aws-sdk-cloudfront/types.rb', line 1002

class CookieNames < Struct.new(
  :quantity,
  :items)
  include Aws::Structure
end