HttpUrlIntegrationProps

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

Bases: object

(experimental) Properties to initialize a new HttpProxyIntegration.

Parameters
  • method (Optional[HttpMethod]) – (experimental) The HTTP method that must be used to invoke the underlying HTTP proxy. Default: HttpMethod.ANY

  • parameter_mapping (Optional[ParameterMapping]) – (experimental) Specifies how to transform HTTP requests before sending them to the backend. Default: undefined requests are sent to the backend unmodified

Stability

experimental

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.aws_apigatewayv2 as apigatewayv2
import aws_cdk.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
)

Attributes

method

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

Default

HttpMethod.ANY

Stability

experimental

Return type

Optional[HttpMethod]

parameter_mapping

(experimental) 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

Stability

experimental

Return type

Optional[ParameterMapping]