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 -
Method Summary
Modifier and TypeMethodDescriptionapiGatewayProps(Object apiGatewayProps) Sets the value ofApiGatewayToLambdaProps.getApiGatewayProps()build()Builds the configured instance.createUsagePlan(Boolean createUsagePlan) Sets the value ofApiGatewayToLambdaProps.getCreateUsagePlan()existingLambdaObj(software.amazon.awscdk.services.lambda.Function existingLambdaObj) Sets the value ofApiGatewayToLambdaProps.getExistingLambdaObj()lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) Sets the value ofApiGatewayToLambdaProps.getLambdaFunctionProps()logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps) Sets the value ofApiGatewayToLambdaProps.getLogGroupProps()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
apiGatewayProps
Sets the value ofApiGatewayToLambdaProps.getApiGatewayProps()- Parameters:
apiGatewayProps- Optional user-provided props to override the default props for the API.- Returns:
this
-
createUsagePlan
Sets the value ofApiGatewayToLambdaProps.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 ofApiGatewayToLambdaProps.getExistingLambdaObj()- Parameters:
existingLambdaObj- Existing instance of Lambda Function object, providing both this andlambdaFunctionPropswill cause an error.- Returns:
this
-
lambdaFunctionProps
public ApiGatewayToLambdaProps.Builder lambdaFunctionProps(software.amazon.awscdk.services.lambda.FunctionProps lambdaFunctionProps) Sets the value ofApiGatewayToLambdaProps.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 ofApiGatewayToLambdaProps.getLogGroupProps()- Parameters:
logGroupProps- User provided props to override the default props for the CloudWatchLogs LogGroup.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<ApiGatewayToLambdaProps>- Returns:
- a new instance of
ApiGatewayToLambdaProps - Throws:
NullPointerException- if any required attribute was not provided
-