class HttpAlbIntegration 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.APIGatewayv2.Integrations.HttpAlbIntegration`
Java	`software.amazon.awscdk.services.apigatewayv2.integrations.HttpAlbIntegration`
Python	`aws_cdk.aws_apigatewayv2_integrations.HttpAlbIntegration`
TypeScript (source)	`@aws-cdk/aws-apigatewayv2-integrations` » `HttpAlbIntegration`

Extends HttpRouteIntegration

The Application Load Balancer integration resource for HTTP API.

Example

import { HttpAlbIntegration } from '@aws-cdk/aws-apigatewayv2-integrations';

declare const lb: elbv2.ApplicationLoadBalancer;
const listener = lb.addListener('listener', { port: 80 });
listener.addTargets('target', {
  port: 80,
});

const httpEndpoint = new apigwv2.HttpApi(this, 'HttpProxyPrivateApi', {
  defaultIntegration: new HttpAlbIntegration('DefaultIntegration', listener, {
    parameterMapping: new apigwv2.ParameterMapping().custom('myKey', 'myValue'),
  }),
});

Initializer

new HttpAlbIntegration(id: string, listener: IApplicationListener, props?: HttpAlbIntegrationProps)

Parameters

id string — id of the underlying integration construct.
listener IApplicationListener — the ELB application listener.
props HttpAlbIntegrationProps — properties to configure the integration.

Properties

Name	Type	Description
connectionType🔹	`HttpConnectionType`
httpMethod🔹	`HttpMethod`
integrationType🔹	`HttpIntegrationType`
payloadFormatVersion🔹	`PayloadFormatVersion`

Methods

Name	Description
bind(options)🔹	Bind this integration to the route.

bind(options)🔹

public bind(options: HttpRouteIntegrationBindOptions): HttpRouteIntegrationConfig

Parameters

options HttpRouteIntegrationBindOptions

Returns

HttpRouteIntegrationConfig

Bind this integration to the route.