Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class HttpAlbIntegration.Builder

java.lang.Object

software.amazon.awscdk.aws_apigatewayv2_integrations.HttpAlbIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpAlbIntegration>

Enclosing class:

HttpAlbIntegration

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

A fluent builder for HttpAlbIntegration.

Method Summary

Modifier and Type	Method	Description
HttpAlbIntegration	build()
static HttpAlbIntegration.Builder	create(String id, IApplicationListener listener)
HttpAlbIntegration.Builder	method(HttpMethod method)	The HTTP method that must be used to invoke the underlying HTTP proxy.
HttpAlbIntegration.Builder	parameterMapping(ParameterMapping parameterMapping)	Specifies how to transform HTTP requests before sending them to the backend.
HttpAlbIntegration.Builder	secureServerName(String secureServerName)	Specifies the server name to verified by HTTPS when calling the backend integration.
HttpAlbIntegration.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 HttpAlbIntegration.Builder create(String id,
 IApplicationListener listener)

Parameters:

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

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

Returns:

a new instance of HttpAlbIntegration.Builder.

method

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

vpcLink

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

Specified by:

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

Returns:

a newly built instance of HttpAlbIntegration.