software.amazon.awscdk.services.cloudfront.origins

Interface RestApiOriginProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, OriginOptions

All Known Implementing Classes:

RestApiOriginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:02.243Z")
 @Stability(value=Experimental)
public interface RestApiOriginProps
extends software.amazon.jsii.JsiiSerializable, OriginOptions

(experimental) Properties for an Origin for an API Gateway REST API.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.services.cloudfront.origins.*;
 Duration duration;
 RestApiOriginProps restApiOriginProps = RestApiOriginProps.builder()
         .connectionAttempts(123)
         .connectionTimeout(duration)
         .customHeaders(Map.of(
                 "customHeadersKey", "customHeaders"))
         .keepaliveTimeout(duration)
         .originShieldRegion("originShieldRegion")
         .readTimeout(duration)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RestApiOriginProps.Builder	builder()
default Duration	getKeepaliveTimeout() (experimental) Specifies how long, in seconds, CloudFront persists its connection to the origin.
default Duration	getReadTimeout() (experimental) 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.awscdk.services.cloudfront.OriginOptions

getConnectionAttempts, getConnectionTimeout, getCustomHeaders, getOriginShieldRegion

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getKeepaliveTimeout

@Stability(value=Experimental)
 @Nullable
default Duration getKeepaliveTimeout()

(experimental) 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(value=Experimental)
 @Nullable
default Duration getReadTimeout()

(experimental) 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(value=Experimental)
static RestApiOriginProps.Builder builder()

Specified by:

builder in interface OriginOptions

Returns:

a RestApiOriginProps.Builder of RestApiOriginProps