Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class HttpAlbIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration

software.amazon.awscdk.aws_apigatewayv2_integrations.HttpAlbIntegration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.445Z")
@Stability(Stable)
public class HttpAlbIntegration
extends HttpRouteIntegration

The Application Load Balancer integration resource for HTTP API.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpAlbIntegration;
 Vpc vpc = new Vpc(this, "VPC");
 ApplicationLoadBalancer lb = ApplicationLoadBalancer.Builder.create(this, "lb").vpc(vpc).build();
 ApplicationListener listener = lb.addListener("listener", BaseApplicationListenerProps.builder().port(80).build());
 listener.addTargets("target", AddApplicationTargetsProps.builder()
         .port(80)
         .build());
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(new HttpAlbIntegration("DefaultIntegration", listener))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpAlbIntegration.Builder	A fluent builder for HttpAlbIntegration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpAlbIntegration(String id, IApplicationListener listener)
	HttpAlbIntegration(String id, IApplicationListener listener, HttpAlbIntegrationProps props)
protected	HttpAlbIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpAlbIntegration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
HttpRouteIntegrationConfig	bind(HttpRouteIntegrationBindOptions options)	Bind this integration to the route.
protected HttpConnectionType	getConnectionType()
protected HttpMethod	getHttpMethod()
protected HttpIntegrationType	getIntegrationType()
protected PayloadFormatVersion	getPayloadFormatVersion()
protected void	setConnectionType(HttpConnectionType value)
protected void	setHttpMethod(HttpMethod value)
protected void	setIntegrationType(HttpIntegrationType value)
protected void	setPayloadFormatVersion(PayloadFormatVersion value)

Methods inherited from class software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration

completeBind

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

HttpAlbIntegration

protected HttpAlbIntegration(software.amazon.jsii.JsiiObjectRef objRef)

HttpAlbIntegration

protected HttpAlbIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

HttpAlbIntegration

@Stability(Stable)
public HttpAlbIntegration(@NotNull
 String id,
 @NotNull
 IApplicationListener listener,
 @Nullable
 HttpAlbIntegrationProps props)

Parameters:

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

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

props - properties to configure the integration.

HttpAlbIntegration

@Stability(Stable)
public HttpAlbIntegration(@NotNull
 String id,
 @NotNull
 IApplicationListener listener)

Parameters:

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

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

Method Details

bind

@Stability(Stable)
@NotNull
public HttpRouteIntegrationConfig bind(@NotNull
 HttpRouteIntegrationBindOptions options)

Bind this integration to the route.

Specified by:

bind in class HttpRouteIntegration

Parameters:

options - This parameter is required.

getConnectionType

@Stability(Stable)
@NotNull
protected HttpConnectionType getConnectionType()

setConnectionType

@Stability(Stable)
protected void setConnectionType(@NotNull
 HttpConnectionType value)

getHttpMethod

@Stability(Stable)
@NotNull
protected HttpMethod getHttpMethod()

setHttpMethod

@Stability(Stable)
protected void setHttpMethod(@NotNull
 HttpMethod value)

getIntegrationType

@Stability(Stable)
@NotNull
protected HttpIntegrationType getIntegrationType()

setIntegrationType

@Stability(Stable)
protected void setIntegrationType(@NotNull
 HttpIntegrationType value)

getPayloadFormatVersion

@Stability(Stable)
@NotNull
protected PayloadFormatVersion getPayloadFormatVersion()

setPayloadFormatVersion

@Stability(Stable)
protected void setPayloadFormatVersion(@NotNull
 PayloadFormatVersion value)