class HttpIntegration (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.HttpIntegration
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#HttpIntegration
Java	software.amazon.awscdk.services.apigatewayv2.HttpIntegration
Python	aws_cdk.aws_apigatewayv2.HttpIntegration
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » HttpIntegration

Implements IConstruct, IDependable, IResource, IHttpIntegration, IIntegration

The integration for an API route.

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

declare const httpApi: apigatewayv2.HttpApi;
declare const integrationCredentials: apigatewayv2.IntegrationCredentials;
declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2.PayloadFormatVersion;
const httpIntegration = new apigatewayv2.HttpIntegration(this, 'MyHttpIntegration', {
  httpApi: httpApi,
  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

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

Parameters

• scope Construct
• id string
• props HttpIntegrationProps

Construct Props

Name	Type	Description
httpApi	IHttpApi	The HTTP API to which this integration should be bound.
integrationType	HttpIntegrationType	Integration type.
connectionId?	string	The ID of the VPC link for a private integration.
connectionType?	HttpConnectionType	The type of the network connection to the integration endpoint.
credentials?	IntegrationCredentials	The credentials with which to invoke the integration.
integrationSubtype?	HttpIntegrationSubtype	Integration subtype.
integrationUri?	string	Integration URI.
method?	HttpMethod	The HTTP method to use when calling the underlying HTTP proxy.
parameterMapping?	ParameterMapping	Specifies how to transform HTTP requests before sending them to the backend.
payloadFormatVersion?	PayloadFormatVersion	The version of the payload format.
secureServerName?	string	Specifies the TLS configuration for a private integration.
timeout?	Duration	The maximum amount of time an integration will run before it returns without a response.

---

httpApi

Type: IHttpApi

The HTTP API to which this integration should be bound.

---

integrationType

Type: HttpIntegrationType

Integration type.

---

connectionId?

Type: string (optional, default: undefined)

The ID of the VPC link for a private integration.

Supported only for HTTP APIs.

---

connectionType?

Type: HttpConnectionType (optional, default: HttpConnectionType.INTERNET)

The type of the network connection to the integration endpoint.

---

credentials?

Type: IntegrationCredentials (optional, default: no credentials, use resource-based permissions on supported AWS services)

The credentials with which to invoke the integration.

---

integrationSubtype?

Type: HttpIntegrationSubtype (optional, default: none, required if no integrationUri is defined.)

Integration subtype.

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

---

integrationUri?

Type: string (optional, default: none, required if no integrationSubtype is defined.)

Integration URI.

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

---

method?

Type: HttpMethod (optional, default: none. required if the integration type is HttpIntegrationType.HTTP_PROXY.)

The HTTP method to use when calling 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

---

payloadFormatVersion?

Type: PayloadFormatVersion (optional, default: defaults to latest in the case of HttpIntegrationType.AWS_PROXY`, irrelevant otherwise.)

The version of the payload format.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html

---

secureServerName?

Type: string (optional, default: undefined private integration traffic will use HTTP protocol)

Specifies the TLS configuration for a private 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.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
httpApi	IHttpApi	The HTTP API associated with this integration.
integrationId	string	Id of the integration.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

httpApi

Type: IHttpApi

The HTTP API associated with this integration.

---

integrationId

Type: string

Id of the integration.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.