Package software.amazon.awscdk.services.cloudfront

Class CfnOriginRequestPolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudfront.CfnOriginRequestPolicy
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.590Z") @Stability(Stable) public class CfnOriginRequestPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::CloudFront::OriginRequestPolicy.

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.services.cloudfront.*;
 CfnOriginRequestPolicy cfnOriginRequestPolicy = CfnOriginRequestPolicy.Builder.create(this, "MyCfnOriginRequestPolicy")
         .originRequestPolicyConfig(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())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnOriginRequestPolicy

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

    • CfnOriginRequestPolicy

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

    • CfnOriginRequestPolicy

      @Stability(Stable) public CfnOriginRequestPolicy(@NotNull Construct scope, @NotNull String id, @NotNull CfnOriginRequestPolicyProps props)
      Create a new AWS::CloudFront::OriginRequestPolicy.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier for the origin request policy.

      For example: befd7079-9bbc-4ebf-8ade-498a3694176c .

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      The date and time when the origin request policy was last modified.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getOriginRequestPolicyConfig

      @Stability(Stable) @NotNull public Object getOriginRequestPolicyConfig()
      The origin request policy configuration.

    • setOriginRequestPolicyConfig

      @Stability(Stable) public void setOriginRequestPolicyConfig(@NotNull IResolvable value)
      The origin request policy configuration.

    • setOriginRequestPolicyConfig

      @Stability(Stable) public void setOriginRequestPolicyConfig(@NotNull CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty value)
      The origin request policy configuration.