AWS CDK Reference

Appearance

v2.274.0

QueryStringsConfigProperty Struct ​

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const queryStringsConfigProperty: cloudfront.CfnCachePolicy.QueryStringsConfigProperty = {
  queryStringBehavior: 'queryStringBehavior',

  // the properties below are optional
  queryStrings: ['queryStrings'],
};

Properties ​

queryStringBehaviorstringquery_string_behaviorstrqueryStringBehaviorStringQueryStringBehaviorstringQueryStringBehavior*stringrequired#
Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
notes

Valid values are:

  • none – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
  • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and in requests that CloudFront sends to the origin.
  • allExcept – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except those that are listed in the QueryStringNames type, which are not included.
  • all – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
queryStringsoptionalstring[]query_stringsoptionaltyping.List[str]queryStringsoptionalList<String>QueryStringsoptionalstring[]QueryStringsoptional*[]*string#
Contains a list of query string names.