interface HttpPrivateIntegrationOptions

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

Base options for private integration.

Example

// 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 httpPrivateIntegrationOptions: apigatewayv2_integrations.HttpPrivateIntegrationOptions = {
  method: apigatewayv2.HttpMethod.ANY,
  parameterMapping: parameterMapping,
  secureServerName: 'secureServerName',
  timeout: cdk.Duration.minutes(30),
  vpcLink: vpcLink,
};

Properties

Name	Type	Description
method?	HttpMethod	The HTTP method that must be used to invoke the underlying HTTP proxy.
parameterMapping?	ParameterMapping	Specifies how to transform HTTP requests before sending them to the backend.
secureServerName?	string	Specifies the server name to verified by HTTPS when calling the backend integration.
timeout?	Duration	The maximum amount of time an integration will run before it returns without a response.
vpcLink?	IVpcLink	The 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

---

timeout?

Type: Duration (optional, default: 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.

---

vpcLink?

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

The vpc link to be used for the private integration.