software.amazon.awscdk.services.cloudfront

Class CacheCookieBehavior

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudfront.CacheCookieBehavior

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:56.845Z")
public class CacheCookieBehavior
extends software.amazon.jsii.JsiiObject

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

Example:

 // Creating a custom cache policy for a Distribution -- all parameters optional
 S3Origin bucketOrigin;
 CachePolicy myCachePolicy = CachePolicy.Builder.create(this, "myCachePolicy")
         .cachePolicyName("MyPolicy")
         .comment("A default policy")
         .defaultTtl(Duration.days(2))
         .minTtl(Duration.minutes(1))
         .maxTtl(Duration.days(10))
         .cookieBehavior(CacheCookieBehavior.all())
         .headerBehavior(CacheHeaderBehavior.allowList("X-CustomHeader"))
         .queryStringBehavior(CacheQueryStringBehavior.denyList("username"))
         .enableAcceptEncodingGzip(true)
         .enableAcceptEncodingBrotli(true)
         .build();
 Distribution.Builder.create(this, "myDistCustomPolicy")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(bucketOrigin)
                 .cachePolicy(myCachePolicy)
                 .build())
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CacheCookieBehavior(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CacheCookieBehavior(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static CacheCookieBehavior	all() All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
static CacheCookieBehavior	allowList(java.lang.String... cookies) Only the provided `cookies` are included in the cache key and automatically included in requests that CloudFront sends to the origin.
static CacheCookieBehavior	denyList(java.lang.String... cookies) All cookies except the provided `cookies` are included in the cache key and automatically included in requests that CloudFront sends to the origin.
java.lang.String	getBehavior() The behavior of cookies: allow all, none, an allow list, or a deny list.
java.util.List<java.lang.String>	getCookies() The cookies to allow or deny, if the behavior is an allow or deny list.
static CacheCookieBehavior	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CacheCookieBehavior

protected CacheCookieBehavior(software.amazon.jsii.JsiiObjectRef objRef)

CacheCookieBehavior

protected CacheCookieBehavior(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

all

public static CacheCookieBehavior all()

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

allowList

public static CacheCookieBehavior allowList(java.lang.String... cookies)

Only the provided `cookies` are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Parameters:

cookies - This parameter is required.

denyList

public static CacheCookieBehavior denyList(java.lang.String... cookies)

All cookies except the provided `cookies` are included in the cache key and automatically included in requests that CloudFront sends to the origin.

Parameters:

cookies - This parameter is required.

none

public static CacheCookieBehavior 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.

getBehavior

public java.lang.String getBehavior()

The behavior of cookies: allow all, none, an allow list, or a deny list.

getCookies

public java.util.List<java.lang.String> getCookies()

The cookies to allow or deny, if the behavior is an allow or deny list.