Class CacheQueryStringBehavior

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

stable

Synopsis

Properties

behavior	The behavior of query strings -- allow all, none, only an allow list, or a deny list.
queryStrings	The query strings to allow or deny, if the behavior is an allow or deny list.

Methods

all()	All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
allowList(queryStrings)	Only the provided queryStrings are included in the cache key and automatically included in requests that CloudFront sends to the origin.
denyList(queryStrings)	All query strings except the provided queryStrings are included in the cache key and automatically included in requests that CloudFront sends to the origin.
none()	Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin.

Properties

behavior

The behavior of query strings -- allow all, none, only an allow list, or a deny list.

stable

Declaration

readonly behavior: string;

Property Value

string

queryStrings

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

stable

Declaration

readonly queryStrings?: string[];

Property Value

string[]

Methods

all()

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

stable

Declaration

static all(): CacheQueryStringBehavior;

Returns

CacheQueryStringBehavior

allowList(queryStrings)

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

stable

Declaration

static allowList(...queryStrings: string[]): CacheQueryStringBehavior;

Parameters

queryStrings string[]

Returns

CacheQueryStringBehavior

denyList(queryStrings)

All query strings except the provided queryStrings are included in the cache key and automatically included in requests that CloudFront sends to the origin.

stable

Declaration

static denyList(...queryStrings: string[]): CacheQueryStringBehavior;

Parameters

queryStrings string[]

Returns

CacheQueryStringBehavior

none()

Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin.

stable

Declaration

static none(): CacheQueryStringBehavior;

Returns

CacheQueryStringBehavior