software.amazon.awscdk.services.cloudfront

Class CacheHeaderBehavior

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudfront.CacheHeaderBehavior

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-11T17:58:48.616Z")
 @Stability(value=Stable)
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();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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(String... headers) Listed headers are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
String	getBehavior() If no headers will be passed, or an allow list of headers.
List<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 software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CacheHeaderBehavior

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

CacheHeaderBehavior

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

Method Detail

allowList

@Stability(value=Stable)
 @NotNull
public static CacheHeaderBehavior allowList(@NotNull
                                                                               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

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
public String getBehavior()

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

getHeaders

@Stability(value=Stable)
 @Nullable
public List<String> getHeaders()

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