class HttpAlbIntegration

Language	Type name
.NET	Amazon.CDK.AwsApigatewayv2Integrations.HttpAlbIntegration
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2integrations#HttpAlbIntegration
Java	software.amazon.awscdk.aws_apigatewayv2_integrations.HttpAlbIntegration
Python	aws_cdk.aws_apigatewayv2_integrations.HttpAlbIntegration
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2_integrations » HttpAlbIntegration

Extends HttpRouteIntegration

The Application Load Balancer integration resource for HTTP API.

Example

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

const vpc = new ec2.Vpc(this, 'VPC');
const lb = new elbv2.ApplicationLoadBalancer(this, 'lb', { vpc });
const listener = lb.addListener('listener', { port: 80 });
listener.addTargets('target', {
  port: 80,
});

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

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

---

connectionType

Type: HttpConnectionType

---

httpMethod

Type: HttpMethod

---

integrationType

Type: HttpIntegrationType

---

payloadFormatVersion

Type: 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.