# HeadersConfigProperty

An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.

- Source: Generated at build time
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

TypeScript:

```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 headersConfigProperty: cloudfront.CfnOriginRequestPolicy.HeadersConfigProperty = {
  headerBehavior: 'headerBehavior',

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

Python:

```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

headers_config_property = cloudfront.CfnOriginRequestPolicy.HeadersConfigProperty(
    header_behavior="headerBehavior",

    # the properties below are optional
    headers=["headers"]
)
```

Java:

```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.*;

HeadersConfigProperty headersConfigProperty = HeadersConfigProperty.builder()
        .headerBehavior("headerBehavior")

        // the properties below are optional
        .headers(List.of("headers"))
        .build();
```

C# / .NET:

```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 headersConfigProperty = new HeadersConfigProperty {
    HeaderBehavior = "headerBehavior",

    // the properties below are optional
    Headers = new [] { "headers" }
};
```

Golang:

```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"

headersConfigProperty := &HeadersConfigProperty{
	HeaderBehavior: jsii.String("headerBehavior"),

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

## Properties

- `headerBehavior`: string (required) — Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:.

  - `none` – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to `none` , any headers that are listed in a `CachePolicy` *are* included in origin requests.
  - `whitelist` – Only the HTTP headers that are listed in the `Headers` type are included in requests that CloudFront sends to the origin.
  - `allViewer` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.
  - `allViewerAndWhitelistCloudFront` – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the `Headers` type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.
  - `allExcept` – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, **except** for those listed in the `Headers` type, which are not included.

- `headers`: string[] — Contains a list of HTTP header names.
