Interface IWebSocketRouteProps
(experimental) Properties to initialize a new Route.
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface IWebSocketRouteProps : IWebSocketRouteOptions
Syntax (vb)
Public Interface IWebSocketRouteProps
Inherits IWebSocketRouteOptions
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
WebSocketApi webSocketApi;
IWebSocketRouteAuthorizer webSocketRouteAuthorizer;
WebSocketRouteIntegration webSocketRouteIntegration;
var webSocketRouteProps = new WebSocketRouteProps {
Integration = webSocketRouteIntegration,
RouteKey = "routeKey",
WebSocketApi = webSocketApi,
// the properties below are optional
ApiKeyRequired = false,
Authorizer = webSocketRouteAuthorizer
};
Synopsis
Properties
ApiKeyRequired | (experimental) Whether the route requires an API Key to be provided. |
RouteKey | (experimental) The key to this route. |
WebSocketApi | (experimental) The API the route is associated with. |
Properties
ApiKeyRequired
(experimental) Whether the route requires an API Key to be provided.
virtual Nullable<bool> ApiKeyRequired { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
RouteKey
(experimental) The key to this route.
string RouteKey { get; }
Property Value
System.String
Remarks
Stability: Experimental
WebSocketApi
(experimental) The API the route is associated with.
IWebSocketApi WebSocketApi { get; }
Property Value
Remarks
Stability: Experimental