# HttpRouteIntegrationConfig

Config returned back as a result of the bind.

- Source: [`aws-apigatewayv2/lib/http/integration.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigatewayv2/lib/http/integration.ts#L393)
- Type last changed: v2.147.0 · 20 Jun 2024

## 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';

declare const integrationCredentials: apigatewayv2.IntegrationCredentials;
declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2.PayloadFormatVersion;
const httpRouteIntegrationConfig: apigatewayv2.HttpRouteIntegrationConfig = {
  payloadFormatVersion: payloadFormatVersion,
  type: apigatewayv2.HttpIntegrationType.HTTP_PROXY,

  // the properties below are optional
  connectionId: 'connectionId',
  connectionType: apigatewayv2.HttpConnectionType.VPC_LINK,
  credentials: integrationCredentials,
  method: apigatewayv2.HttpMethod.ANY,
  parameterMapping: parameterMapping,
  secureServerName: 'secureServerName',
  subtype: apigatewayv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
  timeout: cdk.Duration.minutes(30),
  uri: 'uri',
};
```

## Properties

- `connectionId`: string = undefined — The ID of the VPC link for a private integration.

  Supported only for HTTP APIs.

- `connectionType`: [HttpConnectionType](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.HttpConnectionType.html) = HttpConnectionType.INTERNET — The type of the network connection to the integration endpoint.

- `credentials`: [IntegrationCredentials](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.IntegrationCredentials.html) — The credentials with which to invoke the integration.

  **Default:** no credentials, use resource-based permissions on supported AWS services

- `method`: [HttpMethod](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.HttpMethod.html) = undefined — The HTTP method that must be used to invoke the underlying proxy.

  Required for `HttpIntegrationType.HTTP_PROXY`

- `parameterMapping`: [ParameterMapping](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.ParameterMapping.html) — Specifies how to transform HTTP requests before sending them to the backend.

  **Default:** undefined requests are sent to the backend unmodified

- `payloadFormatVersion`: [PayloadFormatVersion](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.PayloadFormatVersion.html) (required) = undefined — Payload format version in the case of lambda proxy integration.

- `secureServerName`: string — Specifies the server name to verified by HTTPS when calling the backend integration.

  **Default:** undefined private integration traffic will use HTTP protocol

- `subtype`: [HttpIntegrationSubtype](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.HttpIntegrationSubtype.html) — Integration subtype.

  **Default:** none, required if no `integrationUri` is defined.

- `timeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = 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.

- `type`: [HttpIntegrationType](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.HttpIntegrationType.html) (required) — Integration type.

- `uri`: string — Integration URI.

  **Default:** none, required if no `integrationSubtype` is defined.