Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class HttpNlbIntegration.Builder

java.lang.Object

software.amazon.awscdk.aws_apigatewayv2_integrations.HttpNlbIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpNlbIntegration>

Enclosing class:

HttpNlbIntegration

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

A fluent builder for HttpNlbIntegration.

Method Summary

Modifier and Type	Method	Description
HttpNlbIntegration	build()
static HttpNlbIntegration.Builder	create(String id, INetworkListener listener)
HttpNlbIntegration.Builder	method(HttpMethod method)	The HTTP method that must be used to invoke the underlying HTTP proxy.
HttpNlbIntegration.Builder	parameterMapping(ParameterMapping parameterMapping)	Specifies how to transform HTTP requests before sending them to the backend.
HttpNlbIntegration.Builder	secureServerName(String secureServerName)	Specifies the server name to verified by HTTPS when calling the backend integration.
HttpNlbIntegration.Builder	timeout(Duration timeout)	The maximum amount of time an integration will run before it returns without a response.
HttpNlbIntegration.Builder	vpcLink(IVpcLink vpcLink)	The vpc link to be used for the private integration.

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 HttpNlbIntegration.Builder create(String id,
 INetworkListener listener)

Parameters:

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

listener - the ELB network listener. This parameter is required.

Returns:

a new instance of HttpNlbIntegration.Builder.

method

@Stability(Stable)
public HttpNlbIntegration.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 HttpNlbIntegration.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

secureServerName

@Stability(Stable)
public HttpNlbIntegration.Builder secureServerName(String secureServerName)

Specifies the server name to verified by HTTPS when calling the backend integration.

Default: undefined private integration traffic will use HTTP protocol

Parameters:

secureServerName - Specifies the server name to verified by HTTPS when calling the backend integration. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html

timeout

@Stability(Stable)
public HttpNlbIntegration.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

vpcLink

@Stability(Stable)
public HttpNlbIntegration.Builder vpcLink(IVpcLink vpcLink)

The vpc link to be used for the private integration.

Default: - a new VpcLink is created

Parameters:

vpcLink - The vpc link to be used for the private integration. This parameter is required.

Returns:

this

build

@Stability(Stable)
public HttpNlbIntegration build()

Specified by:

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

Returns:

a newly built instance of HttpNlbIntegration.