Interface WebSocketRouteOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
WebSocketRouteProps
- All Known Implementing Classes:
WebSocketRouteOptions.Jsii$Proxy
,WebSocketRouteProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:43.356Z")
@Stability(Experimental)
public interface WebSocketRouteOptions
extends software.amazon.jsii.JsiiSerializable
(experimental) Options used to add route to the API.
Example:
import software.amazon.awscdk.services.apigatewayv2.integrations.WebSocketLambdaIntegration; Function messageHandler; WebSocketApi webSocketApi = new WebSocketApi(this, "mywsapi"); WebSocketStage.Builder.create(this, "mystage") .webSocketApi(webSocketApi) .stageName("dev") .autoDeploy(true) .build(); webSocketApi.addRoute("sendmessage", WebSocketRouteOptions.builder() .integration(new WebSocketLambdaIntegration("SendMessageIntegration", messageHandler)) .build());
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forWebSocketRouteOptions
static final class
An implementation forWebSocketRouteOptions
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default IWebSocketRouteAuthorizer
(experimental) The authorize to this route.(experimental) The integration to be configured on this route.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIntegration
(experimental) The integration to be configured on this route. -
getAuthorizer
(experimental) The authorize to this route.You can only set authorizer to a $connect route.
Default: - No Authorizer
-
builder
- Returns:
- a
WebSocketRouteOptions.Builder
ofWebSocketRouteOptions
-