1.204.0

interface QueryStringsConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.CfnOriginRequestPolicy.QueryStringsConfigProperty
Javasoftware.amazon.awscdk.services.cloudfront.CfnOriginRequestPolicy.QueryStringsConfigProperty
Pythonaws_cdk.aws_cloudfront.CfnOriginRequestPolicy.QueryStringsConfigProperty
TypeScript @aws-cdk/aws-cloudfront » CfnOriginRequestPolicy » QueryStringsConfigProperty

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.

Example

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

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

Properties

NameTypeDescription
queryStringBehaviorstringDetermines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin.
queryStrings?string[]Contains a list of query string names.

queryStringBehavior

Type: string

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

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?

Type: string[] (optional)

Contains a list of query string names.

← PreviousNext →