AWS::CloudFront::OriginRequestPolicy OriginRequestPolicyConfig - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::CloudFront::OriginRequestPolicy OriginRequestPolicyConfig

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

Comment

A comment to describe the origin request policy. The comment cannot be longer than 128 characters.

Required: No

Type: String

Update requires: No interruption

CookiesConfig

The cookies from viewer requests to include in origin requests.

Required: Yes

Type: CookiesConfig

Update requires: No interruption

HeadersConfig

The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

Required: Yes

Type: HeadersConfig

Update requires: No interruption

Name

A unique name to identify the origin request policy.

Required: Yes

Type: String

Update requires: No interruption

QueryStringsConfig

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

Required: Yes

Type: QueryStringsConfig

Update requires: No interruption