Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class HttpUrlIntegration.Builder

java.lang.Object

software.amazon.awscdk.aws_apigatewayv2_integrations.HttpUrlIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpUrlIntegration>

Enclosing class:

HttpUrlIntegration

@Stability(Stable)
public static final class HttpUrlIntegration.Builder
extends Object
implements software.amazon.jsii.Builder<HttpUrlIntegration>

A fluent builder for HttpUrlIntegration.

Method Summary

Modifier and Type	Method	Description
HttpUrlIntegration	build()
static HttpUrlIntegration.Builder	create(String id, String url)
HttpUrlIntegration.Builder	method(HttpMethod method)	The HTTP method that must be used to invoke the underlying HTTP proxy.
HttpUrlIntegration.Builder	parameterMapping(ParameterMapping parameterMapping)	Specifies how to transform HTTP requests before sending them to the backend.
HttpUrlIntegration.Builder	timeout(Duration timeout)	The maximum amount of time an integration will run before it returns without a response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static HttpUrlIntegration.Builder create(String id,
 String url)

Parameters:

id - id of the underlying integration construct. This parameter is required.

url - the URL to proxy to. This parameter is required.

Returns:

a new instance of HttpUrlIntegration.Builder.

method

@Stability(Stable)
public HttpUrlIntegration.Builder method(HttpMethod method)

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

Default: HttpMethod.ANY

Parameters:

method - The HTTP method that must be used to invoke the underlying HTTP proxy. This parameter is required.

Returns:

this

parameterMapping

@Stability(Stable)
public HttpUrlIntegration.Builder parameterMapping(ParameterMapping parameterMapping)

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

Default: undefined requests are sent to the backend unmodified

Parameters:

parameterMapping - Specifies how to transform HTTP requests before sending them to the backend. This parameter is required.

Returns:

this

See Also:

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

timeout

@Stability(Stable)
public HttpUrlIntegration.Builder timeout(Duration 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)

Parameters:

timeout - The maximum amount of time an integration will run before it returns without a response. This parameter is required.

Returns:

this

build

@Stability(Stable)
public HttpUrlIntegration build()

Specified by:

build in interface software.amazon.jsii.Builder<HttpUrlIntegration>

Returns:

a newly built instance of HttpUrlIntegration.