Package 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	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.constructs.Construct scope, String id)
ApiGatewayToLambda.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)	Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
ApiGatewayToLambda.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)	User provided props to override the default props for the Lambda function.
ApiGatewayToLambda.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)	User provided props to override the default props for the CloudWatchLogs LogGroup.

Methods inherited from class java.lang.Object

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

Method Details

create

public static ApiGatewayToLambda.Builder create(software.constructs.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.

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)

Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.

Default: - None

Parameters:

existingLambdaObj - Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error. This parameter is required.

Returns:

this

lambdaFunctionProps

public ApiGatewayToLambda.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)

User provided props to override the default props for the Lambda function.

Default: - Default props are used.

Parameters:

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

Returns:

this

logGroupProps

public ApiGatewayToLambda.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)

User provided props to override the default props for the CloudWatchLogs LogGroup.

Default: - Default props are used

Parameters:

logGroupProps - User provided props to override the default props for the CloudWatchLogs LogGroup. This parameter is required.

Returns:

this

build

public ApiGatewayToLambda build()

Specified by:

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

Returns:

a newly built instance of ApiGatewayToLambda.