@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-25T18:29:07.034Z") public class WebSocketRoute extends Resource implements IWebSocketRoute
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; WebSocketRoute webSocketRoute = WebSocketRoute.Builder.create(this, "MyWebSocketRoute") .integration(webSocketRouteIntegration) .routeKey("routeKey") .webSocketApi(webSocketApi) // the properties below are optional .apiKeyRequired(false) .authorizer(webSocketRouteAuthorizer) .build();
Modifier and Type | Class and Description |
---|---|
static class |
WebSocketRoute.Builder
(experimental) A fluent builder for
WebSocketRoute . |
IWebSocketRoute.Jsii$Default, IWebSocketRoute.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
WebSocketRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
WebSocketRoute(software.amazon.jsii.JsiiObjectRef objRef) |
|
WebSocketRoute(software.constructs.Construct scope,
java.lang.String id,
WebSocketRouteProps props) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getIntegrationResponseId()
(experimental) Integration response ID.
|
java.lang.String |
getRouteId()
(experimental) Id of the Route.
|
java.lang.String |
getRouteKey()
(experimental) The key to this route.
|
IWebSocketApi |
getWebSocketApi()
(experimental) The WebSocket API associated with this route.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected WebSocketRoute(software.amazon.jsii.JsiiObjectRef objRef)
protected WebSocketRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public WebSocketRoute(software.constructs.Construct scope, java.lang.String id, WebSocketRouteProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public java.lang.String getRouteId()
getRouteId
in interface IRoute
public java.lang.String getRouteKey()
getRouteKey
in interface IWebSocketRoute
public IWebSocketApi getWebSocketApi()
getWebSocketApi
in interface IWebSocketRoute
public java.lang.String getIntegrationResponseId()