aws-cdk-lib.aws_apigatewayv2_integrations.WebSocketLambdaIntegrationProps

WebSocketLambdaIntegrationProps Struct

Props for Lambda type integration for a WebSocket Api.

WebSocketLambdaIntegrationProps

used as props by

• WebSocketLambdaIntegration

Source

aws-apigatewayv2-integrations/lib/websocket/lambda.ts

Type last changed

v2.134.0 · 26 Mar 2024

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';
const webSocketLambdaIntegrationProps: apigatewayv2_integrations.WebSocketLambdaIntegrationProps = {
  contentHandling: apigatewayv2.ContentHandling.CONVERT_TO_BINARY,
  timeout: cdk.Duration.minutes(30),
};

Properties

contentHandling?optionalContentHandlingcontent_handling?optionalContentHandlingcontentHandling?optionalContentHandlingContentHandling?optionalContentHandlingContentHandling?optionalContentHandling#

Specifies how to handle response payload content type conversions.

Default: The response payload will be passed through from the integration response to the route response or method response without modification.

timeout?optionalDurationtimeout?optionalDurationtimeout?optionalDurationTimeout?optionalDurationTimeout?optionalDuration= 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.