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

class HttpAlbIntegration ๐Ÿ”น

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

Extends HttpRouteIntegration

The Application Load Balancer integration resource for HTTP API.

Example

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

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

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.