Package software.amazon.awscdk.services.apigateway

Class LambdaRestApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.RestApiBase

software.amazon.awscdk.services.apigateway.RestApi

software.amazon.awscdk.services.apigateway.LambdaRestApi

All Implemented Interfaces:

IRestApiRef, IEnvironmentAware, IResource, IRestApi, IResourceWithPolicy, IResourceWithPolicyV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:57.868Z")
@Stability(Stable)
public class LambdaRestApi
extends RestApi

Defines an API Gateway REST API with AWS Lambda proxy integration.

Use the proxy property to define a greedy proxy ("{proxy+}") and "ANY" method from the specified path. If not defined, you will need to explicity add resources and methods to the API.

Example:

 Queue sourceQueue;
 Function fn = Function.Builder.create(this, "MyFunc")
         .handler("index.handler")
         .runtime(Runtime.NODEJS_LATEST)
         .code(Code.fromInline("exports.handler = e => {}"))
         .build();
 LambdaRestApi restApi = LambdaRestApi.Builder.create(this, "MyRestAPI").handler(fn).build();
 ApiGatewayTarget apiTarget = new ApiGatewayTarget(restApi);
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(new SqsSource(sourceQueue))
         .target(apiTarget)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LambdaRestApi.Builder	A fluent builder for LambdaRestApi.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IResourceWithPolicy

IResourceWithPolicy.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IRestApi

IRestApi.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LambdaRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LambdaRestApi(software.amazon.jsii.JsiiObjectRef objRef)
	LambdaRestApi(software.constructs.Construct scope, String id, LambdaRestApiProps props)

Method Summary

Methods inherited from class software.amazon.awscdk.services.apigateway.RestApi

addModel, addRequestValidator, addToResourcePolicy, fromRestApiAttributes, fromRestApiId, getMethods, getRestApiId, getRestApiRootResourceId, getRoot, isRestApi

Methods inherited from class software.amazon.awscdk.services.apigateway.RestApiBase

addApiKey, addApiKey, addDomainName, addGatewayResponse, addUsagePlan, addUsagePlan, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, arnForExecuteApi, getCloudWatchAccount, getDeploymentStage, getDomainName, getLatestDeployment, getResourcePolicy, getRestApiName, getRestApiRef, getUrl, grantInvokeFromVpcEndpointsOnly, metric, metric, metricCacheHitCount, metricCacheHitCount, metricCacheMissCount, metricCacheMissCount, metricClientError, metricClientError, metricCount, metricCount, metricIntegrationLatency, metricIntegrationLatency, metricLatency, metricLatency, metricServerError, metricServerError, setCloudWatchAccount, setDeploymentStage, setResourcePolicy, urlForPath, urlForPath

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.services.iam.IResourceWithPolicy

getEnv

Methods inherited from interface software.amazon.awscdk.services.apigateway.IRestApi

getEnv, getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

LambdaRestApi

protected LambdaRestApi(software.amazon.jsii.JsiiObjectRef objRef)

LambdaRestApi

protected LambdaRestApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LambdaRestApi

@Stability(Stable)
public LambdaRestApi(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 LambdaRestApiProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.