interface HttpLambdaIntegrationProps

Language	Type name
.NET	Amazon.CDK.AwsApigatewayv2Integrations.HttpLambdaIntegrationProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2integrations#HttpLambdaIntegrationProps
Java	software.amazon.awscdk.aws_apigatewayv2_integrations.HttpLambdaIntegrationProps
Python	aws_cdk.aws_apigatewayv2_integrations.HttpLambdaIntegrationProps
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2_integrations » HttpLambdaIntegrationProps

Lambda Proxy integration properties.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import { aws_apigatewayv2_integrations as apigatewayv2_integrations } from 'aws-cdk-lib';

declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2.PayloadFormatVersion;
const httpLambdaIntegrationProps: apigatewayv2_integrations.HttpLambdaIntegrationProps = {
  parameterMapping: parameterMapping,
  payloadFormatVersion: payloadFormatVersion,
  timeout: cdk.Duration.minutes(30),
};

Properties

Name	Type	Description
parameterMapping?	ParameterMapping	Specifies how to transform HTTP requests before sending them to the backend.
payloadFormatVersion?	PayloadFormatVersion	Version of the payload sent to the lambda handler.
timeout?	Duration	The maximum amount of time an integration will run before it returns without a response.

---

parameterMapping?

Type: ParameterMapping (optional, default: undefined requests are sent to the backend unmodified)

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

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

---

payloadFormatVersion?

Type: PayloadFormatVersion (optional, default: PayloadFormatVersion.VERSION_2_0)

Version of the payload sent to the lambda handler.

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

---

timeout?

Type: Duration (optional, default: Duration.seconds(29))

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

Must be between 50 milliseconds and 29 seconds.