aws-cdk-lib.aws_cloudfront.CfnOriginRequestPolicy.CookiesConfigProperty

interface CookiesConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.CfnOriginRequestPolicy.CookiesConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnOriginRequestPolicy_CookiesConfigProperty
Javasoftware.amazon.awscdk.services.cloudfront.CfnOriginRequestPolicy.CookiesConfigProperty
Pythonaws_cdk.aws_cloudfront.CfnOriginRequestPolicy.CookiesConfigProperty
TypeScript aws-cdk-lib » aws_cloudfront » CfnOriginRequestPolicy » CookiesConfigProperty

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

Example

// 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.CfnOriginRequestPolicy.CookiesConfigProperty = {
  cookieBehavior: 'cookieBehavior',

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

Properties

NameTypeDescription
cookieBehaviorstringDetermines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:.
cookies?string[]Contains a list of cookie names.

cookieBehavior

Type: string

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

  • none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in a CachePolicy are included in origin requests.
  • whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.
  • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.
  • allExcept – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

cookies?

Type: string[] (optional)

Contains a list of cookie names.