@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:58.241Z") public interface LambdaRestApiProps extends RestApiProps
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"));
Modifier and Type | Interface and Description |
---|---|
static class |
LambdaRestApiProps.Builder
A builder for
LambdaRestApiProps |
static class |
LambdaRestApiProps.Jsii$Proxy
An implementation for
LambdaRestApiProps |
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.
|
getApiKeySourceType, getBinaryMediaTypes, getCloneFrom, getDescription, getEndpointConfiguration, getMinimumCompressionSize
getCloudWatchRole, getDeploy, getDeployOptions, getDisableExecuteApiEndpoint, getDomainName, getEndpointExportName, getEndpointTypes, getFailOnWarnings, getParameters, getPolicy, getRestApiName, getRetainDeployments
getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions
IFunction getHandler()
This handler will be used as a the default integration for all methods in
this API, unless specified otherwise in addMethod
.
@Deprecated default RestApiProps getOptions()
default java.lang.Boolean getProxy()
If set to false, you will need to explicitly define the API model using
addResource
and addMethod
(or addProxy
).
Default: true
static LambdaRestApiProps.Builder builder()
builder
in interface ResourceOptions
builder
in interface RestApiBaseProps
builder
in interface RestApiOptions
builder
in interface RestApiProps
LambdaRestApiProps.Builder
of LambdaRestApiProps