Class HttpRouteIntegration

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegration
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
Direct Known Subclasses:
HttpAlbIntegration, HttpLambdaIntegration, HttpNlbIntegration, HttpServiceDiscoveryIntegration, HttpUrlIntegration

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.285Z") @Stability(Experimental) 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();
 
  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    (experimental) Initialize an integration for a route on http api.
    protected
    HttpRouteIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    HttpRouteIntegration(software.amazon.jsii.JsiiObjectRef objRef)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    (experimental) Bind this integration to the route.
    protected void
    (experimental) Complete the binding of the integration to the route.

    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

    • HttpRouteIntegration

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

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

      @Stability(Experimental) protected HttpRouteIntegration(@NotNull String id)
      (experimental) Initialize an integration for a route on http api.

      Parameters:
      id - id of the underlying HttpIntegration construct. This parameter is required.
  • Method Details

    • bind

      @Stability(Experimental) @NotNull public abstract HttpRouteIntegrationConfig bind(@NotNull HttpRouteIntegrationBindOptions options)
      (experimental) Bind this integration to the route.

      Parameters:
      options - This parameter is required.
    • completeBind

      @Stability(Experimental) protected void completeBind(@NotNull 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.