Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class HttpUrlIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration

software.amazon.awscdk.aws_apigatewayv2_integrations.HttpUrlIntegration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-26T00:07:32.545Z")
@Stability(Stable)
public class HttpUrlIntegration
extends HttpRouteIntegration

The HTTP Proxy integration resource for HTTP API.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpLambdaAuthorizer;
 import software.amazon.awscdk.aws_apigatewayv2_authorizers.HttpLambdaResponseType;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpUrlIntegration;
 // This function handles your auth logic
 Function authHandler;
 HttpLambdaAuthorizer authorizer = HttpLambdaAuthorizer.Builder.create("BooksAuthorizer", authHandler)
         .responseTypes(List.of(HttpLambdaResponseType.SIMPLE))
         .build();
 HttpApi api = new HttpApi(this, "HttpApi");
 api.addRoutes(AddRoutesOptions.builder()
         .integration(new HttpUrlIntegration("BooksIntegration", "https://get-books-proxy.example.com"))
         .path("/books")
         .authorizer(authorizer)
         .build());
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	HttpUrlIntegration(String id, String url)
	HttpUrlIntegration(String id, String url, HttpUrlIntegrationProps props)
protected	HttpUrlIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpUrlIntegration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
HttpRouteIntegrationConfig	bind(HttpRouteIntegrationBindOptions _options)	Bind this integration to the route.

Methods inherited from class software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration

completeBind

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

HttpUrlIntegration

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

HttpUrlIntegration

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

HttpUrlIntegration

@Stability(Stable)
public HttpUrlIntegration(@NotNull
 String id,
 @NotNull
 String url,
 @Nullable
 HttpUrlIntegrationProps props)

Parameters:

id - id of the underlying integration construct. This parameter is required.

url - the URL to proxy to. This parameter is required.

props - properties to configure the integration.

HttpUrlIntegration

@Stability(Stable)
public HttpUrlIntegration(@NotNull
 String id,
 @NotNull
 String url)

Parameters:

id - id of the underlying integration construct. This parameter is required.

url - the URL to proxy to. This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public HttpRouteIntegrationConfig bind(@NotNull
 HttpRouteIntegrationBindOptions _options)

Bind this integration to the route.

Specified by:

bind in class HttpRouteIntegration

Parameters:

_options - This parameter is required.