OriginRequestPolicyConfigArgs

data class OriginRequestPolicyConfigArgs(val comment: Output<String>? = null, val cookiesConfig: Output<OriginRequestPolicyCookiesConfigArgs>, val headersConfig: Output<OriginRequestPolicyHeadersConfigArgs>, val name: Output<String>, val queryStringsConfig: Output<OriginRequestPolicyQueryStringsConfigArgs>) : ConvertibleToJava<OriginRequestPolicyConfigArgs>

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

Link copied to clipboard
constructor(comment: Output<String>? = null, cookiesConfig: Output<OriginRequestPolicyCookiesConfigArgs>, headersConfig: Output<OriginRequestPolicyHeadersConfigArgs>, name: Output<String>, queryStringsConfig: Output<OriginRequestPolicyQueryStringsConfigArgs>)

Properties

Link copied to clipboard
val comment: Output<String>? = null

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

Link copied to clipboard

The cookies from viewer requests to include in origin requests.

Link copied to clipboard

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

Link copied to clipboard
val name: Output<String>

A unique name to identify the origin request policy.

Link copied to clipboard

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

Functions

Link copied to clipboard
open override fun toJava(): OriginRequestPolicyConfigArgs