Package software.amazon.awscdk.services.cloudfront

Interface CfnOriginRequestPolicy.CookiesConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOriginRequestPolicy.CookiesConfigProperty.Jsii$Proxy

Enclosing class:

CfnOriginRequestPolicy

@Stability(Stable)
public static interface CfnOriginRequestPolicy.CookiesConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cloudfront.*;
 CookiesConfigProperty cookiesConfigProperty = CookiesConfigProperty.builder()
         .cookieBehavior("cookieBehavior")
         // the properties below are optional
         .cookies(List.of("cookies"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnOriginRequestPolicy.CookiesConfigProperty.Builder	A builder for CfnOriginRequestPolicy.CookiesConfigProperty
static final class	CfnOriginRequestPolicy.CookiesConfigProperty.Jsii$Proxy	An implementation for CfnOriginRequestPolicy.CookiesConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnOriginRequestPolicy.CookiesConfigProperty.Builder	builder()
String	getCookieBehavior()	Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin.
default List<String>	getCookies()	Contains a list of cookie names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCookieBehavior

@Stability(Stable)
@NotNull
String getCookieBehavior()

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.

getCookies

@Stability(Stable)
@Nullable
default List<String> getCookies()

Contains a list of cookie names.

builder

@Stability(Stable)
static CfnOriginRequestPolicy.CookiesConfigProperty.Builder builder()

Returns:

a CfnOriginRequestPolicy.CookiesConfigProperty.Builder of CfnOriginRequestPolicy.CookiesConfigProperty