1.204.0

interface HeadersConfigProperty

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

An object that determines whether any HTTP headers (and if so, which headers) 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 headersConfigProperty: cloudfront.CfnOriginRequestPolicy.HeadersConfigProperty = {
  headerBehavior: 'headerBehavior',

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

Properties

NameTypeDescription
headerBehaviorstringDetermines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:.
headers?string[]Contains a list of HTTP header names.

headerBehavior

Type: string

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?

Type: string[] (optional)

Contains a list of HTTP header names.

← PreviousNext →