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(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty.Builder A builder for CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty
static class	CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty.Jsii$Proxy An implementation for CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty.Builder	builder()
default String	getComment() A comment to describe the origin request policy.
Object	getCookiesConfig() The cookies from viewer requests to include in origin requests.
Object	getHeadersConfig() The HTTP headers to include in origin requests.
String	getName() A unique name to identify the origin request policy.
Object	getQueryStringsConfig() The URL query strings from viewer requests to include in origin requests.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCookiesConfig

@Stability(value=Stable)
 @NotNull
Object getCookiesConfig()

The cookies from viewer requests to include in origin requests.

getHeadersConfig

@Stability(value=Stable)
 @NotNull
Object getHeadersConfig()

The HTTP headers to include in origin requests.

These can include headers from viewer requests and additional headers added by CloudFront.

getName

@Stability(value=Stable)
 @NotNull
String getName()

A unique name to identify the origin request policy.

getQueryStringsConfig

@Stability(value=Stable)
 @NotNull
Object getQueryStringsConfig()

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

getComment

@Stability(value=Stable)
 @Nullable
default String getComment()

A comment to describe the origin request policy.

The comment cannot be longer than 128 characters.

builder

@Stability(value=Stable)
static CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty.Builder builder()

Returns:

a CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty.Builder of CfnOriginRequestPolicy.OriginRequestPolicyConfigProperty