AWS::CloudFront::CachePolicy CookiesConfig - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::CloudFront::CachePolicy CookiesConfig

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "CookieBehavior" : String, "Cookies" : [ String, ... ] }

YAML

CookieBehavior: String Cookies: - String

Properties

CookieBehavior

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

  • none – No cookies in viewer requests are included in the cache key or 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 – Only the cookies in viewer requests that are listed in the CookieNames type are included in the cache key and in requests that CloudFront sends to the origin.

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

  • all – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

Required: Yes

Type: String

Pattern: ^(none|whitelist|allExcept|all)$

Update requires: No interruption

Cookies

Contains a list of cookie names.

Required: No

Type: Array of String

Update requires: No interruption