WebSocketLambdaIntegrationProps

class aws_cdk.aws_apigatewayv2_integrations.WebSocketLambdaIntegrationProps(*, content_handling=None, timeout=None)

Bases: object

Props for Lambda type integration for a WebSocket Api.

Parameters:

  • content_handling (Optional[ContentHandling]) – 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 (Optional[Duration]) – 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)

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_apigatewayv2 as apigatewayv2
from aws_cdk import aws_apigatewayv2_integrations as apigatewayv2_integrations

web_socket_lambda_integration_props = apigatewayv2_integrations.WebSocketLambdaIntegrationProps(
    content_handling=apigatewayv2.ContentHandling.CONVERT_TO_BINARY,
    timeout=cdk.Duration.minutes(30)
)

Attributes

content_handling

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

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)