Package software.amazon.awscdk.services.apigatewayv2

Class HttpIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigatewayv2.HttpIntegration

All Implemented Interfaces:

IEnvironmentAware, IResource, IHttpIntegration, IIntegration, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.073Z")
@Stability(Stable)
public class HttpIntegration
extends Resource
implements IHttpIntegration

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 software.amazon.awscdk.*;
 import software.amazon.awscdk.services.apigatewayv2.*;
 HttpApi httpApi;
 IntegrationCredentials integrationCredentials;
 ParameterMapping parameterMapping;
 PayloadFormatVersion payloadFormatVersion;
 HttpIntegration httpIntegration = HttpIntegration.Builder.create(this, "MyHttpIntegration")
         .httpApi(httpApi)
         .integrationType(HttpIntegrationType.HTTP_PROXY)
         // the properties below are optional
         .connectionId("connectionId")
         .connectionType(HttpConnectionType.VPC_LINK)
         .credentials(integrationCredentials)
         .integrationSubtype(HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS)
         .integrationUri("integrationUri")
         .method(HttpMethod.ANY)
         .parameterMapping(parameterMapping)
         .payloadFormatVersion(payloadFormatVersion)
         .secureServerName("secureServerName")
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	HttpIntegration.Builder	A fluent builder for HttpIntegration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IHttpIntegration

IHttpIntegration.Jsii$Default, IHttpIntegration.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpIntegration(software.amazon.jsii.JsiiObjectRef objRef)
	HttpIntegration(software.constructs.Construct scope, String id, HttpIntegrationProps props)

Method Summary

Modifier and Type	Method	Description
IHttpApi	getHttpApi()	The HTTP API associated with this integration.
String	getIntegrationId()	Id of the integration.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

HttpIntegration

protected HttpIntegration(software.amazon.jsii.JsiiObjectRef objRef)

HttpIntegration

protected HttpIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

HttpIntegration

@Stability(Stable)
public HttpIntegration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 HttpIntegrationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getHttpApi

@Stability(Stable)
@NotNull
public IHttpApi getHttpApi()

The HTTP API associated with this integration.

Specified by:

getHttpApi in interface IHttpIntegration

getIntegrationId

@Stability(Stable)
@NotNull
public String getIntegrationId()

Id of the integration.

Specified by:

getIntegrationId in interface IIntegration