Package software.amazon.awscdk.services.apigateway

Interface LambdaRestApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceOptions, RestApiBaseProps, RestApiProps

All Known Implementing Classes:

LambdaRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:03.510Z")
@Stability(Stable)
public interface LambdaRestApiProps
extends software.amazon.jsii.JsiiSerializable, RestApiProps

Example:

 Function backend;
 LambdaRestApi api = LambdaRestApi.Builder.create(this, "myapi")
         .handler(backend)
         .proxy(false)
         .build();
 Resource items = api.root.addResource("items");
 items.addMethod("GET"); // GET /items
 items.addMethod("POST"); // POST /items
 Resource item = items.addResource("{item}");
 item.addMethod("GET"); // GET /items/{item}
 // the default integration for methods is "handler", but one can
 // customize this behavior per method or even a sub path.
 item.addMethod("DELETE", new HttpIntegration("http://amazon.com"));
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static LambdaRestApiProps.Builder	builder()
IFunction	getHandler()	The default Lambda function that handles all requests from this API.
default LambdaIntegrationOptions	getIntegrationOptions()	Specific Lambda integration options.
default Boolean	getProxy()	If true, route all requests to the Lambda Function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

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

getCloudWatchRole, getCloudWatchRoleRemovalPolicy, getDeploy, getDeployOptions, getDescription, getDisableExecuteApiEndpoint, getDomainName, getEndpointExportName, getEndpointTypes, getFailOnWarnings, getParameters, getPolicy, getRestApiName, getRetainDeployments

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

getApiKeySourceType, getBinaryMediaTypes, getCloneFrom, getEndpointConfiguration, getMinCompressionSize, getMinimumCompressionSize

Method Details

getHandler

@Stability(Stable)
@NotNull
IFunction getHandler()

The default Lambda function that handles all requests from this API.

This handler will be used as a the default integration for all methods in this API, unless specified otherwise in addMethod.

getIntegrationOptions

@Stability(Stable)
@Nullable
default LambdaIntegrationOptions getIntegrationOptions()

Specific Lambda integration options.

Default: see defaults defined in `LambdaIntegrationOptions`.

getProxy

@Stability(Stable)
@Nullable
default Boolean getProxy()

If true, route all requests to the Lambda Function.

If set to false, you will need to explicitly define the API model using addResource and addMethod (or addProxy).

Default: true

builder

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

Returns:

a LambdaRestApiProps.Builder of LambdaRestApiProps