interface OriginRequestPolicyConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CloudFront.CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty`
Java	`software.amazon.awscdk.services.cloudfront.CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty`
Python	`aws_cdk.aws_cloudfront.CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty`
TypeScript	`@aws-cdk/aws-cloudfront` » `CfnOriginRequestPolicy` » `OriginRequestPolicyConfigProperty`

An origin request policy configuration.

This configuration determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:

The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host , User-Agent , and X-Amz-Cf-Id .
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can't find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy .

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 originRequestPolicyConfigProperty: cloudfront.CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty = {
  cookiesConfig: {
    cookieBehavior: 'cookieBehavior',

    // the properties below are optional
    cookies: ['cookies'],
  },
  headersConfig: {
    headerBehavior: 'headerBehavior',

    // the properties below are optional
    headers: ['headers'],
  },
  name: 'name',
  queryStringsConfig: {
    queryStringBehavior: 'queryStringBehavior',

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

  // the properties below are optional
  comment: 'comment',
};

Properties

Name	Type	Description
cookiesConfig	`IResolvable` `\|` `CookiesConfigProperty`	The cookies from viewer requests to include in origin requests.
headersConfig	`IResolvable` `\|` `HeadersConfigProperty`	The HTTP headers to include in origin requests.
name	`string`	A unique name to identify the origin request policy.
queryStringsConfig	`IResolvable` `\|` `QueryStringsConfigProperty`	The URL query strings from viewer requests to include in origin requests.
comment?	`string`	A comment to describe the origin request policy.

cookiesConfig

Type: IResolvable | CookiesConfigProperty

The cookies from viewer requests to include in origin requests.

headersConfig

Type: IResolvable | HeadersConfigProperty

The HTTP headers to include in origin requests.

These can include headers from viewer requests and additional headers added by CloudFront.

name

Type: string

A unique name to identify the origin request policy.

queryStringsConfig

Type: IResolvable | QueryStringsConfigProperty

The URL query strings from viewer requests to include in origin requests.

comment?

Type: string (optional)

A comment to describe the origin request policy.

The comment cannot be longer than 128 characters.