AWS CDK Reference

Appearance

v2.275.0

HttpNlbIntegrationProps Struct ​

Properties to initialize HttpNlbIntegration.

Source
aws-apigatewayv2-integrations/lib/http/nlb.ts
Type last changed
v2.114.0 · 5 Dec 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import { aws_apigatewayv2_integrations as apigatewayv2_integrations } from 'aws-cdk-lib';

declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const vpcLink: apigatewayv2.VpcLink;
const httpNlbIntegrationProps: apigatewayv2_integrations.HttpNlbIntegrationProps = {
  method: apigatewayv2.HttpMethod.ANY,
  parameterMapping: parameterMapping,
  secureServerName: 'secureServerName',
  timeout: cdk.Duration.minutes(30),
  vpcLink: vpcLink,
};

Properties ​

methodoptionalHttpMethodmethodoptionalHttpMethodmethodoptionalHttpMethodMethodoptionalHttpMethodMethodoptionalHttpMethod= HttpMethod.ANY#
The HTTP method that must be used to invoke the underlying HTTP proxy.
parameterMappingoptionalParameterMappingparameter_mappingoptionalParameterMappingparameterMappingoptionalParameterMappingParameterMappingoptionalParameterMappingParameterMappingoptionalParameterMapping#
Specifies how to transform HTTP requests before sending them to the backend.

Default: undefined requests are sent to the backend unmodified

secureServerNameoptionalstringsecure_server_nameoptionalstrsecureServerNameoptionalStringSecureServerNameoptionalstringSecureServerNameoptional*string#
Specifies the server name to verified by HTTPS when calling the backend integration.

Default: undefined private integration traffic will use HTTP protocol

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Duration.seconds(29)#
The maximum amount of time an integration will run before it returns without a response.

Must be between 50 milliseconds and 29 seconds.