software.amazon.awscdk.services.apigatewayv2

Class HttpRouteIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration

Direct Known Subclasses:

HttpAlbIntegration, HttpLambdaIntegration, HttpNlbIntegration, HttpServiceDiscoveryIntegration, HttpUrlIntegration

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:40.774Z")
public abstract class HttpRouteIntegration
extends software.amazon.jsii.JsiiObject

(experimental) The interface that various route integration classes will inherit.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpAlbIntegration;
 ApplicationLoadBalancer lb;
 ApplicationListener listener = lb.addListener("listener", BaseApplicationListenerProps.builder().port(80).build());
 listener.addTargets("target", AddApplicationTargetsProps.builder()
         .port(80)
         .build());
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(HttpAlbIntegration.Builder.create("DefaultIntegration", listener)
                 .parameterMapping(new ParameterMapping().custom("myKey", "myValue"))
                 .build())
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpRouteIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpRouteIntegration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
abstract HttpRouteIntegrationConfig	bind(HttpRouteIntegrationBindOptions options) (experimental) Bind this integration to the route.
protected void	completeBind(HttpRouteIntegrationBindOptions _options) (experimental) Complete the binding of the integration to the route.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRouteIntegration

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

HttpRouteIntegration

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

Method Detail

bind

public abstract HttpRouteIntegrationConfig bind(HttpRouteIntegrationBindOptions options)

(experimental) Bind this integration to the route.

Parameters:

options - This parameter is required.

completeBind

protected void completeBind(HttpRouteIntegrationBindOptions _options)

(experimental) Complete the binding of the integration to the route.

In some cases, there is some additional work to do, such as adding permissions for the API to access the target. This work is necessary whether the integration has just been created for this route or it is an existing one, previously created for other routes. In most cases, however, concrete implementations do not need to override this method.

Parameters:

_options - This parameter is required.