aws-cdk-lib.aws_cloudfront.CfnOriginRequestPolicy.QueryStringsConfigProperty

QueryStringsConfigProperty Struct

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// 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.CfnOriginRequestPolicy.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 requests that CloudFront sends to the origin.

notes

Valid values are:

• none – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in a CachePolicy are included in origin requests.
• whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.
• all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.
• allExcept – All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.

queryStrings?optionalstring[]query_strings?optionaltyping.List[str]queryStrings?optionalList<String>QueryStrings?optionalstring[]QueryStrings?optional*[]*string#

Contains a list of query string names.