# HttpIntegrationProps

The integration properties.

Extends: HttpIntegrationProps
Used as props by: HttpIntegration

- Source: [`aws-apigatewayv2/lib/http/integration.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-apigatewayv2/lib/http/integration.ts#L165)
- Type last changed: v2.235.0 · 15 Jan 2026

## 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 httpApiRef: apigatewayv2.IHttpApiRef;
declare const integrationCredentials: apigatewayv2.IntegrationCredentials;
declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2.PayloadFormatVersion;
const httpIntegrationProps: apigatewayv2.HttpIntegrationProps = {
  httpApi: httpApiRef,
  integrationType: apigatewayv2.HttpIntegrationType.HTTP_PROXY,

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

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

- `httpApi`: [IHttpApiRef](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.IHttpApiRef.html) (required) — The HTTP API to which this integration should be bound.

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

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

  Used for AWS Service integrations, specifies the target of the integration.

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

- `integrationUri`: string — Integration URI.

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

  This will be the function ARN in the case of `HttpIntegrationType.AWS_PROXY`,
  or HTTP URL in the case of `HttpIntegrationType.HTTP_PROXY`.

- `method`: [HttpMethod](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.HttpMethod.html) — The HTTP method to use when calling the underlying HTTP proxy.

  **Default:** none. required if the integration type is `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) — The version of the payload format.

  **Default:** defaults to latest in the case of HttpIntegrationType.AWS_PROXY`, irrelevant otherwise.

- `secureServerName`: string — Specifies the TLS configuration for a private integration.

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

- `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.