software.amazon.awscdk.services.cloudfront

Interface CfnCachePolicy.CookiesConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCachePolicy.CookiesConfigProperty.Jsii$Proxy

Enclosing class:

CfnCachePolicy

@Stability(value=Stable)
public static interface CfnCachePolicy.CookiesConfigProperty
extends software.amazon.jsii.JsiiSerializable

An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically 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 and Description
static class	CfnCachePolicy.CookiesConfigProperty.Builder A builder for CfnCachePolicy.CookiesConfigProperty
static class	CfnCachePolicy.CookiesConfigProperty.Jsii$Proxy An implementation for CfnCachePolicy.CookiesConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnCachePolicy.CookiesConfigProperty.Builder	builder()
String	getCookieBehavior() Determines whether any cookies in viewer requests are included in the cache key and automatically 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 Detail

getCookieBehavior

@Stability(value=Stable)
 @NotNull
String getCookieBehavior()

Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Valid values are:

• none – Cookies in viewer requests are not included in the cache key and are not automatically included 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 – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
• allExcept – All cookies in viewer requests that are not listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
• all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

getCookies

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

Contains a list of cookie names.

builder

@Stability(value=Stable)
static CfnCachePolicy.CookiesConfigProperty.Builder builder()

Returns:

a CfnCachePolicy.CookiesConfigProperty.Builder of CfnCachePolicy.CookiesConfigProperty