class HttpNlbIntegration

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

Extends HttpRouteIntegration

The Network Load Balancer integration resource for HTTP API.

Example

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

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

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

Initializer

new HttpNlbIntegration(id: string, listener: INetworkListener, props?: HttpNlbIntegrationProps)

Parameters

id string — id of the underlying integration construct.
listener INetworkListener — the ELB network listener.
props HttpNlbIntegrationProps — 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.