class Aws::CloudFront::Types::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`.
@note When making an API call, you may pass OriginRequestPolicyConfig
data as a hash: { comment: "string", name: "string", # required headers_config: { # required header_behavior: "none", # required, accepts none, whitelist, allViewer, allViewerAndWhitelistCloudFront headers: { quantity: 1, # required items: ["string"], }, }, cookies_config: { # required cookie_behavior: "none", # required, accepts none, whitelist, all cookies: { quantity: 1, # required items: ["string"], }, }, query_strings_config: { # required query_string_behavior: "none", # required, accepts none, whitelist, all query_strings: { quantity: 1, # required items: ["string"], }, }, }
@!attribute [rw] comment
A comment to describe the origin request policy. The comment cannot be longer than 128 characters. @return [String]
@!attribute [rw] name
A unique name to identify the origin request policy. @return [String]
@!attribute [rw] headers_config
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront. @return [Types::OriginRequestPolicyHeadersConfig]
@!attribute [rw] cookies_config
The cookies from viewer requests to include in origin requests. @return [Types::OriginRequestPolicyCookiesConfig]
@!attribute [rw] query_strings_config
The URL query strings from viewer requests to include in origin requests. @return [Types::OriginRequestPolicyQueryStringsConfig]
@see docs.aws.amazon.com/goto/WebAPI/cloudfront-2020-05-31/OriginRequestPolicyConfig AWS API Documentation
Constants
- SENSITIVE