AWS CDK Reference

Appearance

v2.274.0

CookiesConfigProperty Struct ​

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.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const cookiesConfigProperty: cloudfront.CfnCachePolicy.CookiesConfigProperty = {
  cookieBehavior: 'cookieBehavior',

  // the properties below are optional
  cookies: ['cookies'],
};

Properties ​

cookieBehaviorstringcookie_behaviorstrcookieBehaviorStringCookieBehaviorstringCookieBehavior*stringrequired#
Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
notes

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.
cookiesoptionalstring[]cookiesoptionaltyping.List[str]cookiesoptionalList<String>Cookiesoptionalstring[]Cookiesoptional*[]*string#
Contains a list of cookie names.