AWS CDK Reference

Appearance

v2.274.0

OriginRequestCookieBehavior Class ​

Determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.

Source
aws-cloudfront/lib/origin-request-policy.ts
Type last changed
v2.88.0 · 20 Jul 2023

Example ​

ts
// Creating a custom origin request policy for a Distribution -- all parameters optional
declare const bucketOrigin: origins.S3Origin;
const myOriginRequestPolicy = new cloudfront.OriginRequestPolicy(this, 'OriginRequestPolicy', {
  originRequestPolicyName: 'MyPolicy',
  comment: 'A default policy',
  cookieBehavior: cloudfront.OriginRequestCookieBehavior.none(),
  headerBehavior: cloudfront.OriginRequestHeaderBehavior.all('CloudFront-Is-Android-Viewer'),
  queryStringBehavior: cloudfront.OriginRequestQueryStringBehavior.allowList('username'),
});

new cloudfront.Distribution(this, 'myDistCustomPolicy', {
  defaultBehavior: {
    origin: bucketOrigin,
    originRequestPolicy: myOriginRequestPolicy,
  },
});

Properties ​

behaviorstringbehaviorstrbehaviorStringBehaviorstringBehavior*stringrequired#
The behavior of cookies: allow all, none or an allow list.
cookiesstring[]cookiestyping.List[str]cookiesList<String>Cookiesstring[]Cookies*[]*string#
The cookies to allow, if the behavior is an allow list.

Methods ​

all(): OriginRequestCookieBehavior // chainable@staticmethod def all() -> OriginRequestCookieBehaviorpublic static OriginRequestCookieBehavior all()public static OriginRequestCookieBehavior All()func All() OriginRequestCookieBehaviorstatic#
All cookies in viewer requests are included in requests that CloudFront sends to the origin.
allowList(...cookies: string[]): OriginRequestCookieBehavior // chainable@staticmethod def allow_list(cookies: str) -> OriginRequestCookieBehaviorpublic static OriginRequestCookieBehavior allowList(String cookies)public static OriginRequestCookieBehavior AllowList(string cookies)func AllowList(Cookies *string) OriginRequestCookieBehaviorstatic#
Only the provided `cookies` are included in requests that CloudFront sends to the origin.
denyList(...cookies: string[]): OriginRequestCookieBehavior // chainable@staticmethod def deny_list(cookies: str) -> OriginRequestCookieBehaviorpublic static OriginRequestCookieBehavior denyList(String cookies)public static OriginRequestCookieBehavior DenyList(string cookies)func DenyList(Cookies *string) OriginRequestCookieBehaviorstatic#
All cookies except the provided `cookies` are included in requests that CloudFront sends to the origin.
none(): OriginRequestCookieBehavior // chainable@staticmethod def none() -> OriginRequestCookieBehaviorpublic static OriginRequestCookieBehavior none()public static OriginRequestCookieBehavior None()func None() OriginRequestCookieBehaviorstatic#
Cookies in viewer requests are not included in requests that CloudFront sends to the origin.

Any cookies that are listed in a CachePolicy are still included in origin requests.