HttpUrlIntegrationProps

class aws_cdk.aws_apigatewayv2_integrations.HttpUrlIntegrationProps(*, method=None, parameter_mapping=None, timeout=None)

Bases: object

Properties to initialize a new HttpProxyIntegration.

Parameters:

method (Optional[HttpMethod]) – The HTTP method that must be used to invoke the underlying HTTP proxy. Default: HttpMethod.ANY
parameter_mapping (Optional[ParameterMapping]) – Specifies how to transform HTTP requests before sending them to the backend. Default: undefined requests are sent to the backend unmodified
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

# parameter_mapping: apigatewayv2.ParameterMapping

http_url_integration_props = apigatewayv2_integrations.HttpUrlIntegrationProps(
    method=apigatewayv2.HttpMethod.ANY,
    parameter_mapping=parameter_mapping,
    timeout=cdk.Duration.minutes(30)
)

Attributes

method

The HTTP method that must be used to invoke the underlying HTTP proxy.

Default:: HttpMethod.ANY

parameter_mapping

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

Default:: undefined requests are sent to the backend unmodified
See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

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)