Package software.amazon.awscdk.cfnpropertymixins.services.cloudfront

Class CfnOriginRequestPolicyPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.cloudfront.CfnOriginRequestPolicyPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:57.090Z") @Stability(Stable) public class CfnOriginRequestPolicyPropsMixin extends Mixin implements software.constructs.IMixin
An origin request policy.

When it's attached to a cache behavior, the origin request policy 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.cfnpropertymixins.services.cloudfront.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnOriginRequestPolicyPropsMixin cfnOriginRequestPolicyPropsMixin = CfnOriginRequestPolicyPropsMixin.Builder.create(CfnOriginRequestPolicyMixinProps.builder()
         .originRequestPolicyConfig(OriginRequestPolicyConfigProperty.builder()
                 .comment("comment")
                 .cookiesConfig(CookiesConfigProperty.builder()
                         .cookieBehavior("cookieBehavior")
                         .cookies(List.of("cookies"))
                         .build())
                 .headersConfig(HeadersConfigProperty.builder()
                         .headerBehavior("headerBehavior")
                         .headers(List.of("headers"))
                         .build())
                 .name("name")
                 .queryStringsConfig(QueryStringsConfigProperty.builder()
                         .queryStringBehavior("queryStringBehavior")
                         .queryStrings(List.of("queryStrings"))
                         .build())
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnOriginRequestPolicyPropsMixin

      protected CfnOriginRequestPolicyPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOriginRequestPolicyPropsMixin

      protected CfnOriginRequestPolicyPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOriginRequestPolicyPropsMixin

      @Stability(Stable) public CfnOriginRequestPolicyPropsMixin(@NotNull CfnOriginRequestPolicyMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::CloudFront::OriginRequestPolicy.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnOriginRequestPolicyPropsMixin

      @Stability(Stable) public CfnOriginRequestPolicyPropsMixin(@NotNull CfnOriginRequestPolicyMixinProps props)
      Create a mixin to apply properties to AWS::CloudFront::OriginRequestPolicy.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnOriginRequestPolicyMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()