# HttpIntegration

The integration for an API route.

Extends: Construct › Resource › HttpIntegration
Implements: IResource, IHttpIntegration, IIntegration, IEnvironmentAware, IIntegrationRef, IConstruct, IDependable

- CloudFormation: [`AWS::ApiGatewayV2::Integration`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigatewayv2-integration.html)
- L1 type: [`CfnIntegration`](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.CfnIntegration.html)
- 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#L255)
- 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 httpIntegration = new apigatewayv2.HttpIntegration(this, 'MyHttpIntegration', {
  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),
});
```

## Initializer

```ts
new HttpIntegration(scope: Construct, id: string, props: HttpIntegrationProps)
```

## Construct Props

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

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `httpApi`: [IHttpApi](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.IHttpApi.html) — The HTTP API associated with this integration.

- `integrationId`: string — Id of the integration.

- `integrationRef`: [IntegrationReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_apigatewayv2.IntegrationReference.html) — A reference to a Integration resource.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.