software.amazon.awscdk.services.cloudfront

Class CacheHeaderBehavior

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudfront.CacheHeaderBehavior

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

Determines whether any HTTP headers 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	CacheHeaderBehavior(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CacheHeaderBehavior(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static CacheHeaderBehavior	allowList(java.lang.String... headers) Listed headers are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
java.lang.String	getBehavior() If no headers will be passed, or an allow list of headers.
java.util.List<java.lang.String>	getHeaders() The headers for the allow/deny list, if applicable.
static CacheHeaderBehavior	none() HTTP headers 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

CacheHeaderBehavior

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

CacheHeaderBehavior

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

Method Detail

allowList

public static CacheHeaderBehavior allowList(java.lang.String... headers)

Listed headers are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

Parameters:

headers - This parameter is required.

none

public static CacheHeaderBehavior none()

HTTP headers 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()

If no headers will be passed, or an allow list of headers.

getHeaders

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

The headers for the allow/deny list, if applicable.