Package software.amazon.awscdk.aws_apigatewayv2_integrations

Interface HttpUrlIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpUrlIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-24T10:56:26.806Z")
@Stability(Stable)
public interface HttpUrlIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Properties to initialize a new HttpProxyIntegration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.apigatewayv2.*;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.*;
 ParameterMapping parameterMapping;
 HttpUrlIntegrationProps httpUrlIntegrationProps = HttpUrlIntegrationProps.builder()
         .method(HttpMethod.ANY)
         .parameterMapping(parameterMapping)
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpUrlIntegrationProps.Builder	A builder for HttpUrlIntegrationProps
static final class	HttpUrlIntegrationProps.Jsii$Proxy	An implementation for HttpUrlIntegrationProps

Method Summary

Modifier and Type	Method	Description
static HttpUrlIntegrationProps.Builder	builder()
default HttpMethod	getMethod()	The HTTP method that must be used to invoke the underlying HTTP proxy.
default ParameterMapping	getParameterMapping()	Specifies how to transform HTTP requests before sending them to the backend.
default Duration	getTimeout()	The maximum amount of time an integration will run before it returns without a response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMethod

@Stability(Stable)
@Nullable
default HttpMethod getMethod()

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

Default: HttpMethod.ANY

getParameterMapping

@Stability(Stable)
@Nullable
default ParameterMapping getParameterMapping()

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

Default: undefined requests are sent to the backend unmodified

See Also:

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

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

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)

builder

@Stability(Stable)
static HttpUrlIntegrationProps.Builder builder()

Returns:

a HttpUrlIntegrationProps.Builder of HttpUrlIntegrationProps