software.amazon.awsconstructs.services.apigatewaylambda

Class ApiGatewayToLambda.Builder

java.lang.Object

software.amazon.awsconstructs.services.apigatewaylambda.ApiGatewayToLambda.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiGatewayToLambda>

Enclosing class:

ApiGatewayToLambda

public static final class ApiGatewayToLambda.Builder
extends Object
implements software.amazon.jsii.Builder<ApiGatewayToLambda>

A fluent builder for ApiGatewayToLambda.

Method Summary

Modifier and Type	Method and Description
ApiGatewayToLambda.Builder	apiGatewayProps(Object apiGatewayProps) Optional user-provided props to override the default props for the API.
ApiGatewayToLambda	build()
static ApiGatewayToLambda.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
ApiGatewayToLambda.Builder	deployLambda(Boolean deployLambda) Whether to create a new Lambda function or use an existing Lambda function.
ApiGatewayToLambda.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) An optional, existing Lambda function.
ApiGatewayToLambda.Builder	lambdaFunctionProps(Object lambdaFunctionProps) Optional user-provided props to override the default props for the Lambda function.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ApiGatewayToLambda.Builder create(software.amazon.awscdk.core.Construct scope,
                                                String id)

Parameters:

scope - - represents the scope for all the resources. This parameter is required.

id - - this is a a scope-unique id. This parameter is required.

Returns:

a new instance of ApiGatewayToLambda.Builder.

deployLambda

public ApiGatewayToLambda.Builder deployLambda(Boolean deployLambda)

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

Parameters:

deployLambda - Whether to create a new Lambda function or use an existing Lambda function. This parameter is required.

Returns:

this

apiGatewayProps

public ApiGatewayToLambda.Builder apiGatewayProps(Object apiGatewayProps)

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

Default: - Default props are used.

Parameters:

apiGatewayProps - Optional user-provided props to override the default props for the API. This parameter is required.

Returns:

this

existingLambdaObj

public ApiGatewayToLambda.Builder existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)

An optional, existing Lambda function.

This property is required if deployLambda is set to false.

Default: - None

Parameters:

existingLambdaObj - An optional, existing Lambda function. This parameter is required.

Returns:

this

lambdaFunctionProps

public ApiGatewayToLambda.Builder lambdaFunctionProps(Object lambdaFunctionProps)

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.

Parameters:

lambdaFunctionProps - Optional user-provided props to override the default props for the Lambda function. This parameter is required.

Returns:

this

build

public ApiGatewayToLambda build()

Specified by:

build in interface software.amazon.jsii.Builder<ApiGatewayToLambda>