Skip to content

CloudFront  >  Structures  >  OriginRequestPolicyConfig

OriginRequestPolicyConfig

Structure Class

OriginRequestPolicyConfig dataclass

Bases: _SerdeShape

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.

Attributes

comment class-attribute instance-attribute 
comment: str | None = ...

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

cookies_config instance-attribute 
cookies_config: OriginRequestPolicyCookiesConfig

The cookies from viewer requests to include in origin requests.

headers_config instance-attribute 
headers_config: OriginRequestPolicyHeadersConfig

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

name instance-attribute 
name: str

A unique name to identify the origin request policy.

query_strings_config instance-attribute 
query_strings_config: OriginRequestPolicyQueryStringsConfig

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