Skip to content
v2.277.0

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.

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.CfnOriginRequestPolicy.QueryStringsConfigProperty = {
  queryStringBehavior: 'queryStringBehavior',

  // the properties below are optional
  queryStrings: ['queryStrings'],
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudfront as cloudfront

query_strings_config_property = cloudfront.CfnOriginRequestPolicy.QueryStringsConfigProperty(
    query_string_behavior="queryStringBehavior",

    # the properties below are optional
    query_strings=["queryStrings"]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cloudfront.*;

QueryStringsConfigProperty queryStringsConfigProperty = QueryStringsConfigProperty.builder()
        .queryStringBehavior("queryStringBehavior")

        // the properties below are optional
        .queryStrings(List.of("queryStrings"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;

var queryStringsConfigProperty = new QueryStringsConfigProperty {
    QueryStringBehavior = "queryStringBehavior",

    // the properties below are optional
    QueryStrings = new [] { "queryStrings" }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

queryStringsConfigProperty := &QueryStringsConfigProperty{
	QueryStringBehavior: jsii.String("queryStringBehavior"),

	// the properties below are optional
	QueryStrings: []*string{
		jsii.String("queryStrings"),
	},
}

Properties ​

queryStringBehaviorstringquery_string_behaviorstrqueryStringBehaviorStringQueryStringBehaviorstringQueryStringBehavior*string required #
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.
queryStringsoptionalstring[]query_stringsoptionaltyping.List[str]queryStringsoptionalList<String>QueryStringsoptionalstring[]QueryStringsoptional*[]*string #
Contains a list of query string names.