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

interface HttpAlbIntegrationProps ๐Ÿ”น

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

Properties to initialize HttpAlbIntegration.

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()
      .appendHeader('header2', apigwv2.MappingValue.requestHeader('header1'))
      .removeHeader('header1'),
  }),
});

Properties

NameTypeDescription
method?๐Ÿ”นHttpMethodThe HTTP method that must be used to invoke the underlying HTTP proxy.
parameterMapping?๐Ÿ”นParameterMappingSpecifies how to transform HTTP requests before sending them to the backend.
secureServerName?๐Ÿ”นstringSpecifies the server name to verified by HTTPS when calling the backend integration.
vpcLink?๐Ÿ”นIVpcLinkThe vpc link to be used for the private integration.

method?๐Ÿ”น

Type: HttpMethod (optional, default: HttpMethod.ANY)

The HTTP method that must be used to invoke the underlying HTTP proxy.


parameterMapping?๐Ÿ”น

Type: ParameterMapping (optional, default: undefined requests are sent to the backend unmodified)

Specifies how to transform HTTP requests before sending them to the backend.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html


secureServerName?๐Ÿ”น

Type: string (optional, default: undefined private integration traffic will use HTTP protocol)

Specifies the server name to verified by HTTPS when calling the backend integration.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html


vpcLink?๐Ÿ”น

Type: IVpcLink (optional, default: a new VpcLink is created)

The vpc link to be used for the private integration.