# OriginRequestQueryStringBehavior

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.

Obtainable from: OriginRequestQueryStringBehavior.all, OriginRequestQueryStringBehavior.allowList, OriginRequestQueryStringBehavior.denyList, OriginRequestQueryStringBehavior.none

- Source: [`aws-cloudfront/lib/origin-request-policy.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-cloudfront/lib/origin-request-policy.ts#L250)
- Type last changed: v2.88.0 · 20 Jul 2023

## Example

TypeScript:

```ts
// Creating a custom origin request policy for a Distribution -- all parameters optional
declare const bucketOrigin: origins.S3Origin;
const myOriginRequestPolicy = new cloudfront.OriginRequestPolicy(this, 'OriginRequestPolicy', {
  originRequestPolicyName: 'MyPolicy',
  comment: 'A default policy',
  cookieBehavior: cloudfront.OriginRequestCookieBehavior.none(),
  headerBehavior: cloudfront.OriginRequestHeaderBehavior.all('CloudFront-Is-Android-Viewer'),
  queryStringBehavior: cloudfront.OriginRequestQueryStringBehavior.allowList('username'),
});

new cloudfront.Distribution(this, 'myDistCustomPolicy', {
  defaultBehavior: {
    origin: bucketOrigin,
    originRequestPolicy: myOriginRequestPolicy,
  },
});
```

Python:

```python
# Creating a custom origin request policy for a Distribution -- all parameters optional
# bucket_origin: origins.S3Origin

my_origin_request_policy = cloudfront.OriginRequestPolicy(self, "OriginRequestPolicy",
    origin_request_policy_name="MyPolicy",
    comment="A default policy",
    cookie_behavior=cloudfront.OriginRequestCookieBehavior.none(),
    header_behavior=cloudfront.OriginRequestHeaderBehavior.all("CloudFront-Is-Android-Viewer"),
    query_string_behavior=cloudfront.OriginRequestQueryStringBehavior.allow_list("username")
)

cloudfront.Distribution(self, "myDistCustomPolicy",
    default_behavior=cloudfront.BehaviorOptions(
        origin=bucket_origin,
        origin_request_policy=my_origin_request_policy
    )
)
```

Java:

```java
// Creating a custom origin request policy for a Distribution -- all parameters optional
S3Origin bucketOrigin;

OriginRequestPolicy myOriginRequestPolicy = OriginRequestPolicy.Builder.create(this, "OriginRequestPolicy")
        .originRequestPolicyName("MyPolicy")
        .comment("A default policy")
        .cookieBehavior(OriginRequestCookieBehavior.none())
        .headerBehavior(OriginRequestHeaderBehavior.all("CloudFront-Is-Android-Viewer"))
        .queryStringBehavior(OriginRequestQueryStringBehavior.allowList("username"))
        .build();

Distribution.Builder.create(this, "myDistCustomPolicy")
        .defaultBehavior(BehaviorOptions.builder()
                .origin(bucketOrigin)
                .originRequestPolicy(myOriginRequestPolicy)
                .build())
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// Creating a custom origin request policy for a Distribution -- all parameters optional
S3Origin bucketOrigin;

var myOriginRequestPolicy = new OriginRequestPolicy(this, "OriginRequestPolicy", new OriginRequestPolicyProps {
    OriginRequestPolicyName = "MyPolicy",
    Comment = "A default policy",
    CookieBehavior = OriginRequestCookieBehavior.None(),
    HeaderBehavior = OriginRequestHeaderBehavior.All("CloudFront-Is-Android-Viewer"),
    QueryStringBehavior = OriginRequestQueryStringBehavior.AllowList("username")
});

new Distribution(this, "myDistCustomPolicy", new DistributionProps {
    DefaultBehavior = new BehaviorOptions {
        Origin = bucketOrigin,
        OriginRequestPolicy = myOriginRequestPolicy
    }
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Creating a custom origin request policy for a Distribution -- all parameters optional
var bucketOrigin S3Origin

myOriginRequestPolicy := cloudfront.NewOriginRequestPolicy(this, jsii.String("OriginRequestPolicy"), &OriginRequestPolicyProps{
	OriginRequestPolicyName: jsii.String("MyPolicy"),
	Comment: jsii.String("A default policy"),
	CookieBehavior: cloudfront.OriginRequestCookieBehavior_None(),
	HeaderBehavior: cloudfront.OriginRequestHeaderBehavior_All(jsii.String("CloudFront-Is-Android-Viewer")),
	QueryStringBehavior: cloudfront.OriginRequestQueryStringBehavior_AllowList(jsii.String("username")),
})

cloudfront.NewDistribution(this, jsii.String("myDistCustomPolicy"), &DistributionProps{
	DefaultBehavior: &BehaviorOptions{
		Origin: bucketOrigin,
		OriginRequestPolicy: myOriginRequestPolicy,
	},
})
```

## Properties

- `behavior`: string — The behavior of query strings -- allow all, none, or only an allow list.

- `queryStrings`: string[] — The query strings to allow, if the behavior is an allow list.

## Methods

- `all(): OriginRequestQueryStringBehavior // chainable` (static) — All query strings in viewer requests are included in requests that CloudFront sends to the origin.

- `allowList(...queryStrings: string[]): OriginRequestQueryStringBehavior // chainable` (static) — Only the provided `queryStrings` are included in requests that CloudFront sends to the origin.

- `denyList(...queryStrings: string[]): OriginRequestQueryStringBehavior // chainable` (static) — All query strings except the provided `queryStrings` are included in requests that CloudFront sends to the origin.

- `none(): OriginRequestQueryStringBehavior // chainable` (static) — Query strings in viewer requests are not included in requests that CloudFront sends to the origin.

  Any query strings that are listed in a CachePolicy are still included in origin requests.
