Package software.amazon.awscdk.services.cloudfront

Interface CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty.Jsii$Proxy
Enclosing class:
CfnOriginRequestPolicy
@Stability(Stable) public static interface CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty extends software.amazon.jsii.JsiiSerializable
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 OriginRequestPolicyConfigProperty originRequestPolicyConfigProperty = OriginRequestPolicyConfigProperty.builder()
         .cookiesConfig(CookiesConfigProperty.builder()
                 .cookieBehavior("cookieBehavior")
                 // the properties below are optional
                 .cookies(List.of("cookies"))
                 .build())
         .headersConfig(HeadersConfigProperty.builder()
                 .headerBehavior("headerBehavior")
                 // the properties below are optional
                 .headers(List.of("headers"))
                 .build())
         .name("name")
         .queryStringsConfig(QueryStringsConfigProperty.builder()
                 .queryStringBehavior("queryStringBehavior")
                 // the properties below are optional
                 .queryStrings(List.of("queryStrings"))
                 .build())
         // the properties below are optional
         .comment("comment")
         .build();

See Also: