Package software.amazon.awscdk.services.cloudfront.origins

Interface RestApiOriginProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, OriginOptions, OriginProps

All Known Implementing Classes:

RestApiOriginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:36.322Z")
@Stability(Stable)
public interface RestApiOriginProps
extends software.amazon.jsii.JsiiSerializable, OriginProps

Properties for an Origin for an API Gateway REST API.

Example:

 RestApi api;
 Distribution.Builder.create(this, "Distribution")
         .defaultBehavior(BehaviorOptions.builder().origin(RestApiOrigin.Builder.create(api).originPath("/custom-origin-path").build()).build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RestApiOriginProps.Builder	builder()
default Duration	getKeepaliveTimeout()	Specifies how long, in seconds, CloudFront persists its connection to the origin.
default Duration	getReadTimeout()	Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

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

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

getOriginPath

Method Details

getKeepaliveTimeout

@Stability(Stable)
@Nullable
default Duration getKeepaliveTimeout()

Specifies how long, in seconds, CloudFront persists its connection to the origin.

The valid range is from 1 to 180 seconds, inclusive.

Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

Default: Duration.seconds(5)

getReadTimeout

@Stability(Stable)
@Nullable
default Duration getReadTimeout()

Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.

The valid range is from 1 to 180 seconds, inclusive.

Note that values over 60 seconds are possible only after a limit increase request for the origin response timeout quota has been approved in the target account; otherwise, values over 60 seconds will produce an error at deploy time.

Default: Duration.seconds(30)

builder

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

Returns:

a RestApiOriginProps.Builder of RestApiOriginProps