OriginRequestPolicyConfig class

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.

Constructors

OriginRequestPolicyConfig({required OriginRequestPolicyCookiesConfig cookiesConfig, required OriginRequestPolicyHeadersConfig headersConfig, required String name, required OriginRequestPolicyQueryStringsConfig queryStringsConfig, String? comment})
OriginRequestPolicyConfig.fromXml(XmlElement elem)
factory

Properties

comment → String?
A comment to describe the origin request policy.
final
cookiesConfig → OriginRequestPolicyCookiesConfig
The cookies from viewer requests to include in origin requests.
final
hashCode → int
The hash code for this object.
no setterinherited
headersConfig → OriginRequestPolicyHeadersConfig
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
final
name → String
A unique name to identify the origin request policy.
final
queryStringsConfig → OriginRequestPolicyQueryStringsConfig
The URL query strings from viewer requests to include in origin requests.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
toXml(String elemName, {List<XmlAttribute>? attributes}) → XmlElement

Operators

operator ==(Object other) → bool
The equality operator.
inherited