Skip to content
v2.278.0

CookiesConfigProperty Struct ​

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 ​

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

  // the properties below are optional
  cookies: ['cookies'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudfront as cloudfront

cookies_config_property = cloudfront.CfnOriginRequestPolicy.CookiesConfigProperty(
    cookie_behavior="cookieBehavior",

    # the properties below are optional
    cookies=["cookies"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cloudfront.*;

CookiesConfigProperty cookiesConfigProperty = CookiesConfigProperty.builder()
        .cookieBehavior("cookieBehavior")

        // the properties below are optional
        .cookies(List.of("cookies"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;

var cookiesConfigProperty = new CookiesConfigProperty {
    CookieBehavior = "cookieBehavior",

    // the properties below are optional
    Cookies = new [] { "cookies" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cookiesConfigProperty := &CookiesConfigProperty{
	CookieBehavior: jsii.String("cookieBehavior"),

	// the properties below are optional
	Cookies: []*string{
		jsii.String("cookies"),
	},
}

Properties ​

cookieBehaviorstringcookie_behaviorstrcookieBehaviorStringCookieBehaviorstringCookieBehavior*string required #
Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:.
notes
  • 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.
cookiesoptionalstring[]cookiesoptionaltyping.List[str]cookiesoptionalList<String>Cookiesoptionalstring[]Cookiesoptional*[]*string #
Contains a list of cookie names.