software.amazon.awsconstructs.services.apigatewaylambda

Interface ApiGatewayToLambdaProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiGatewayToLambdaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.8.0 (build 4a047ac)",
           date="2020-07-06T19:16:51.476Z")
public interface ApiGatewayToLambdaProps
extends software.amazon.jsii.JsiiSerializable

The properties for the ApiGatewayToLambda class.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ApiGatewayToLambdaProps.Builder	builder()
default Object	getApiGatewayProps() Optional user-provided props to override the default props for the API.
Boolean	getDeployLambda() Whether to create a new Lambda function or use an existing Lambda function.
default software.amazon.awscdk.services.lambda.Function	getExistingLambdaObj() An optional, existing Lambda function.
default Object	getLambdaFunctionProps() Optional user-provided props to override the default props for the Lambda function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeployLambda

@NotNull
Boolean getDeployLambda()

Whether to create a new Lambda function or use an existing Lambda function.

If set to false, you must provide an existing function for the existingLambdaObj property.

Default: - true

getApiGatewayProps

@Nullable
default Object getApiGatewayProps()

Optional user-provided props to override the default props for the API.

Default: - Default props are used.

getExistingLambdaObj

@Nullable
default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()

An optional, existing Lambda function.

This property is required if deployLambda is set to false.

Default: - None

getLambdaFunctionProps

@Nullable
default Object getLambdaFunctionProps()

Optional user-provided props to override the default props for the Lambda function.

This property is only required if deployLambda is set to true.

Default: - Default props are used.

builder

static ApiGatewayToLambdaProps.Builder builder()

Returns:

a ApiGatewayToLambdaProps.Builder of ApiGatewayToLambdaProps