Package 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.119.0 (build 1634eac)",
           date="2026-01-30T02:56:26.103Z")
public interface ApiGatewayToLambdaProps
extends software.amazon.jsii.JsiiSerializable

The properties for the ApiGatewayToLambda class.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApiGatewayToLambdaProps.Builder	builder()
default Object	getApiGatewayProps()	Optional - user-provided props to override the default props for the API Gateway API.
default Boolean	getCreateUsagePlan()	Whether to create a Usage Plan attached to the API.
default software.amazon.awscdk.services.lambda.Function	getExistingLambdaObj()	Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
default software.amazon.awscdk.services.lambda.FunctionProps	getLambdaFunctionProps()	Optional - user provided props to override the default props for the Lambda function.
default software.amazon.awscdk.services.logs.LogGroupProps	getLogGroupProps()	User provided props to override the default props for the CloudWatchLogs LogGroup.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiGatewayProps

@Nullable
default Object getApiGatewayProps()

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

Default: - Default props are used.

getCreateUsagePlan

@Nullable
default Boolean getCreateUsagePlan()

Whether to create a Usage Plan attached to the API.

Must be true if apiGatewayProps.defaultMethodOptions.apiKeyRequired is true

Default: - true (to match legacy behavior)

getExistingLambdaObj

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

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

Default: - None

getLambdaFunctionProps

@Nullable
default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()

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

Providing both this and existingLambdaObj causes an error.

Default: - Default props are used.

getLogGroupProps

@Nullable
default software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()

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

Default: - Default props are used

builder

static ApiGatewayToLambdaProps.Builder builder()

Returns:

a ApiGatewayToLambdaProps.Builder of ApiGatewayToLambdaProps