@aws-cdk_aws-apigatewayv2-integrations-alpha.HttpNlbIntegration

class HttpNlbIntegration ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Integrations.Alpha.HttpNlbIntegration
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2integrationsalpha/v2#HttpNlbIntegration
Javasoftware.amazon.awscdk.services.apigatewayv2.integrations.alpha.HttpNlbIntegration
Pythonaws_cdk.aws_apigatewayv2_integrations_alpha.HttpNlbIntegration
TypeScript (source)@aws-cdk/aws-apigatewayv2-integrations-alpha ยป HttpNlbIntegration

Extends HttpRouteIntegration

The Network Load Balancer integration resource for HTTP API.

Example

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

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

NameTypeDescription
connectionType๐Ÿ”นHttpConnectionType
httpMethod๐Ÿ”นHttpMethod
integrationType๐Ÿ”นHttpIntegrationType
payloadFormatVersion๐Ÿ”นPayloadFormatVersion

connectionType๐Ÿ”น

Type: HttpConnectionType


httpMethod๐Ÿ”น

Type: HttpMethod


integrationType๐Ÿ”น

Type: HttpIntegrationType


payloadFormatVersion๐Ÿ”น

Type: PayloadFormatVersion

Methods

NameDescription
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.