Package software.amazon.awscdk.services.cloudfront

Interface OriginProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, OriginOptions

All Known Subinterfaces:

FunctionUrlOriginBaseProps, FunctionUrlOriginProps, FunctionUrlOriginWithOACProps, HttpOriginProps, LoadBalancerV2OriginProps, RestApiOriginProps, S3BucketOriginBaseProps, S3BucketOriginWithOACProps, S3BucketOriginWithOAIProps, S3OriginProps, S3StaticWebsiteOriginProps, VpcOriginProps, VpcOriginWithEndpointProps

All Known Implementing Classes:

FunctionUrlOriginBaseProps.Jsii$Proxy, FunctionUrlOriginProps.Jsii$Proxy, FunctionUrlOriginWithOACProps.Jsii$Proxy, HttpOriginProps.Jsii$Proxy, LoadBalancerV2OriginProps.Jsii$Proxy, OriginProps.Jsii$Proxy, RestApiOriginProps.Jsii$Proxy, S3BucketOriginBaseProps.Jsii$Proxy, S3BucketOriginWithOACProps.Jsii$Proxy, S3BucketOriginWithOAIProps.Jsii$Proxy, S3OriginProps.Jsii$Proxy, S3StaticWebsiteOriginProps.Jsii$Proxy, VpcOriginProps.Jsii$Proxy, VpcOriginWithEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:47.116Z")
@Stability(Stable)
public interface OriginProps
extends software.amazon.jsii.JsiiSerializable, OriginOptions

Properties to define an Origin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.cloudfront.*;
 OriginProps originProps = OriginProps.builder()
         .connectionAttempts(123)
         .connectionTimeout(Duration.minutes(30))
         .customHeaders(Map.of(
                 "customHeadersKey", "customHeaders"))
         .originAccessControlId("originAccessControlId")
         .originId("originId")
         .originPath("originPath")
         .originShieldEnabled(false)
         .originShieldRegion("originShieldRegion")
         .responseCompletionTimeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OriginProps.Builder	builder()
default String	getOriginPath()	An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.cloudfront.OriginOptions

getConnectionAttempts, getConnectionTimeout, getCustomHeaders, getOriginAccessControlId, getOriginId, getOriginShieldEnabled, getOriginShieldRegion, getResponseCompletionTimeout

Method Details

getOriginPath

@Stability(Stable)
@Nullable
default String getOriginPath()

An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin.

Must begin, but not end, with '/' (e.g., '/production/images').

Default: '/'

builder

@Stability(Stable)
static OriginProps.Builder builder()

Returns:

a OriginProps.Builder of OriginProps