software.amazon.awscdk.services.apigateway

Interface LambdaRestApiProps

All Superinterfaces:

ResourceOptions, RestApiBaseProps, RestApiOptions, RestApiProps

All Known Implementing Classes:

LambdaRestApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:58.241Z")
public interface LambdaRestApiProps
extends 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 and Description
static class	LambdaRestApiProps.Builder A builder for LambdaRestApiProps
static class	LambdaRestApiProps.Jsii$Proxy An implementation for LambdaRestApiProps

Method Summary

Modifier and Type	Method and Description
static LambdaRestApiProps.Builder	builder()
IFunction	getHandler() The default Lambda function that handles all requests from this API.
default RestApiProps	getOptions() Deprecated. the `LambdaRestApiProps` now extends `RestApiProps`, so all options are just available here. Note that the options specified in `options` will be overridden by any props specified at the root level.
default java.lang.Boolean	getProxy() If true, route all requests to the Lambda Function.

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

getApiKeySourceType, getBinaryMediaTypes, getCloneFrom, getDescription, getEndpointConfiguration, getMinimumCompressionSize

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

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

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

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Method Detail

getHandler

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.

getOptions

@Deprecated
default RestApiProps getOptions()

Deprecated. the `LambdaRestApiProps` now extends `RestApiProps`, so all options are just available here. Note that the options specified in `options` will be overridden by any props specified at the root level.

Default: - no options.

getProxy

default java.lang.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

static LambdaRestApiProps.Builder builder()

Specified by:

builder in interface ResourceOptions

Specified by:

builder in interface RestApiBaseProps

Specified by:

builder in interface RestApiOptions

Specified by:

builder in interface RestApiProps

Returns:

a LambdaRestApiProps.Builder of LambdaRestApiProps