Package software.amazon.awscdk.aws_apigatewayv2_integrations

Interface HttpLambdaIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpLambdaIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.447Z")
@Stability(Stable)
public interface HttpLambdaIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Lambda Proxy integration properties.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpLambdaIntegration;
 Function booksDefaultFn;
 HttpApi httpApi = new HttpApi(this, "HttpApi");
 HttpLambdaIntegration getBooksIntegration = HttpLambdaIntegration.Builder.create("GetBooksIntegration", booksDefaultFn)
         .scopePermissionToRoute(false)
         .build();
 HttpLambdaIntegration createBookIntegration = HttpLambdaIntegration.Builder.create("CreateBookIntegration", booksDefaultFn)
         .scopePermissionToRoute(false)
         .build();
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/books")
         .methods(List.of(HttpMethod.GET))
         .integration(getBooksIntegration)
         .build());
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/books")
         .methods(List.of(HttpMethod.POST))
         .integration(createBookIntegration)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpLambdaIntegrationProps.Builder	builder()
default ParameterMapping	getParameterMapping()	Specifies how to transform HTTP requests before sending them to the backend.
default PayloadFormatVersion	getPayloadFormatVersion()	Version of the payload sent to the lambda handler.
default Boolean	getScopePermissionToRoute()	Scope the permission for invoking the AWS Lambda down to the specific route associated with this integration.
default Duration	getTimeout()	The maximum amount of time an integration will run before it returns without a response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getParameterMapping

@Stability(Stable)
@Nullable
default ParameterMapping getParameterMapping()

Specifies how to transform HTTP requests before sending them to the backend.

Default: undefined requests are sent to the backend unmodified

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

getPayloadFormatVersion

@Stability(Stable)
@Nullable
default PayloadFormatVersion getPayloadFormatVersion()

Version of the payload sent to the lambda handler.

Default: PayloadFormatVersion.VERSION_2_0

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html

getScopePermissionToRoute

@Stability(Stable)
@Nullable
default Boolean getScopePermissionToRoute()

Scope the permission for invoking the AWS Lambda down to the specific route associated with this integration.

If this is set to false, the permission will allow invoking the AWS Lambda from any route. This is useful for reducing the AWS Lambda policy size for cases where the same AWS Lambda function is reused for many integrations.

Default: true

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

The maximum amount of time an integration will run before it returns without a response.

Must be between 50 milliseconds and 29 seconds.

Default: Duration.seconds(29)

builder

@Stability(Stable)
static HttpLambdaIntegrationProps.Builder builder()

Returns:

a HttpLambdaIntegrationProps.Builder of HttpLambdaIntegrationProps