software.amazon.awscdk.services.apigatewayv2

Interface WebSocketRouteProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, WebSocketRouteOptions

All Known Implementing Classes:

WebSocketRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:02.087Z")
 @Stability(value=Experimental)
public interface WebSocketRouteProps
extends software.amazon.jsii.JsiiSerializable, WebSocketRouteOptions

(experimental) Properties to initialize a new 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.services.apigatewayv2.*;
 WebSocketApi webSocketApi;
 IWebSocketRouteAuthorizer webSocketRouteAuthorizer;
 WebSocketRouteIntegration webSocketRouteIntegration;
 WebSocketRouteProps webSocketRouteProps = WebSocketRouteProps.builder()
         .integration(webSocketRouteIntegration)
         .routeKey("routeKey")
         .webSocketApi(webSocketApi)
         // the properties below are optional
         .authorizer(webSocketRouteAuthorizer)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocketRouteProps.Builder A builder for WebSocketRouteProps
static class	WebSocketRouteProps.Jsii$Proxy An implementation for WebSocketRouteProps

Method Summary

Modifier and Type	Method and Description
static WebSocketRouteProps.Builder	builder()
String	getRouteKey() (experimental) The key to this route.
IWebSocketApi	getWebSocketApi() (experimental) The API the route is associated with.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.WebSocketRouteOptions

getAuthorizer, getIntegration

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRouteKey

@Stability(value=Experimental)
 @NotNull
String getRouteKey()

(experimental) The key to this route.

getWebSocketApi

@Stability(value=Experimental)
 @NotNull
IWebSocketApi getWebSocketApi()

(experimental) The API the route is associated with.

builder

@Stability(value=Experimental)
static WebSocketRouteProps.Builder builder()

Specified by:

builder in interface WebSocketRouteOptions

Returns:

a WebSocketRouteProps.Builder of WebSocketRouteProps