Class WebSocketRoute

All Implemented Interfaces:
IConstruct, IDependable, IResource, IRoute, IWebSocketRoute,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.350Z") @Stability(Experimental) public class WebSocketRoute extends Resource implements IWebSocketRoute
(experimental) Route class that creates the Route for API Gateway WebSocket API.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 WebSocketApi webSocketApi;
 IWebSocketRouteAuthorizer webSocketRouteAuthorizer;
 WebSocketRouteIntegration webSocketRouteIntegration;
 WebSocketRoute webSocketRoute = WebSocketRoute.Builder.create(this, "MyWebSocketRoute")
         // the properties below are optional
  • Constructor Details

    • WebSocketRoute

      protected WebSocketRoute( objRef)
    • WebSocketRoute

      protected WebSocketRoute( initializationMode)
    • WebSocketRoute

      @Stability(Experimental) public WebSocketRoute(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull WebSocketRouteProps props)
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
  • Method Details

    • getRouteId

      @Stability(Experimental) @NotNull public String getRouteId()
      (experimental) Id of the Route.
      Specified by:
      getRouteId in interface IRoute
    • getRouteKey

      @Stability(Experimental) @NotNull public String getRouteKey()
      (experimental) The key to this route.
      Specified by:
      getRouteKey in interface IWebSocketRoute
    • getWebSocketApi

      @Stability(Experimental) @NotNull public IWebSocketApi getWebSocketApi()
      (experimental) The WebSocket API associated with this route.
      Specified by:
      getWebSocketApi in interface IWebSocketRoute
    • getIntegrationResponseId

      @Stability(Experimental) @Nullable public String getIntegrationResponseId()
      (experimental) Integration response ID.