Package software.amazon.awsconstructs.services.apigatewaylambda

Class ApiGatewayToLambdaProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.apigatewaylambda.ApiGatewayToLambdaProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiGatewayToLambdaProps>

Enclosing interface:

ApiGatewayToLambdaProps

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

A builder for ApiGatewayToLambdaProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiGatewayToLambdaProps.Builder	apiGatewayProps(Object apiGatewayProps)	Sets the value of ApiGatewayToLambdaProps.getApiGatewayProps()
ApiGatewayToLambdaProps	build()	Builds the configured instance.
ApiGatewayToLambdaProps.Builder	createUsagePlan(Boolean createUsagePlan)	Sets the value of ApiGatewayToLambdaProps.getCreateUsagePlan()
ApiGatewayToLambdaProps.Builder	existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj)	Sets the value of ApiGatewayToLambdaProps.getExistingLambdaObj()
ApiGatewayToLambdaProps.Builder	lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps)	Sets the value of ApiGatewayToLambdaProps.getLambdaFunctionProps()
ApiGatewayToLambdaProps.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)	Sets the value of ApiGatewayToLambdaProps.getLogGroupProps()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

apiGatewayProps

public ApiGatewayToLambdaProps.Builder apiGatewayProps(Object apiGatewayProps)

Sets the value of ApiGatewayToLambdaProps.getApiGatewayProps()

Parameters:

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

Returns:

this

createUsagePlan

public ApiGatewayToLambdaProps.Builder createUsagePlan(Boolean createUsagePlan)

Sets the value of ApiGatewayToLambdaProps.getCreateUsagePlan()

Parameters:

createUsagePlan - Whether to create a Usage Plan attached to the API. Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true

Returns:

this

existingLambdaObj

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

Sets the value of ApiGatewayToLambdaProps.getExistingLambdaObj()

Parameters:

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

Returns:

this

lambdaFunctionProps

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

Sets the value of ApiGatewayToLambdaProps.getLambdaFunctionProps()

Parameters:

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

Returns:

this

logGroupProps

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

Sets the value of ApiGatewayToLambdaProps.getLogGroupProps()

Parameters:

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

Returns:

this

build

public ApiGatewayToLambdaProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApiGatewayToLambdaProps

Throws:

NullPointerException - if any required attribute was not provided