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

Interface FunctionUrlOriginProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, OriginOptions, OriginProps

All Known Implementing Classes:

FunctionUrlOriginProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-22T22:42:48.576Z")
@Stability(Stable)
public interface FunctionUrlOriginProps
extends software.amazon.jsii.JsiiSerializable, OriginProps

Properties for a Lambda Function URL 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.origins.*;
 FunctionUrlOriginProps functionUrlOriginProps = FunctionUrlOriginProps.builder()
         .connectionAttempts(123)
         .connectionTimeout(Duration.minutes(30))
         .customHeaders(Map.of(
                 "customHeadersKey", "customHeaders"))
         .keepaliveTimeout(Duration.minutes(30))
         .originId("originId")
         .originPath("originPath")
         .originShieldEnabled(false)
         .originShieldRegion("originShieldRegion")
         .readTimeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FunctionUrlOriginProps.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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getConnectionAttempts, getConnectionTimeout, getCustomHeaders, getOriginId, getOriginShieldEnabled, getOriginShieldRegion

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.

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 FunctionUrlOriginProps.Builder builder()

Returns:

a FunctionUrlOriginProps.Builder of FunctionUrlOriginProps