interface HeadersConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CloudFront.CfnCachePolicy.HeadersConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnCachePolicy_HeadersConfigProperty`
Java	`software.amazon.awscdk.services.cloudfront.CfnCachePolicy.HeadersConfigProperty`
Python	`aws_cdk.aws_cloudfront.CfnCachePolicy.HeadersConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_cloudfront` » `CfnCachePolicy` » `HeadersConfigProperty`

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and 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 { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const headersConfigProperty: cloudfront.CfnCachePolicy.HeadersConfigProperty = {
  headerBehavior: 'headerBehavior',

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

Properties

Name	Type	Description
headerBehavior	`string`	Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin.
headers?	`string[]`	Contains a list of HTTP header names.

headerBehavior

Type: string

Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin.

Valid values are:

none – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
whitelist – Only the HTTP headers that are listed in the Headers type are included in the cache key and in requests that CloudFront sends to the origin.

headers?

Type: string[] (optional)

Contains a list of HTTP header names.