Class WebSocketRouteProps
(experimental) Properties to initialize a new Route.
Inheritance
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class WebSocketRouteProps : Object, IWebSocketRouteProps, IWebSocketRouteOptions
Syntax (vb)
Public Class WebSocketRouteProps
Inherits Object
Implements IWebSocketRouteProps, 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
Constructors
WebSocketRouteProps() |
Properties
ApiKeyRequired | (experimental) Whether the route requires an API Key to be provided. |
Authorizer | (experimental) The authorize to this route. |
Integration | (experimental) The integration to be configured on this route. |
RouteKey | (experimental) The key to this route. |
WebSocketApi | (experimental) The API the route is associated with. |
Constructors
WebSocketRouteProps()
public WebSocketRouteProps()
Properties
ApiKeyRequired
(experimental) Whether the route requires an API Key to be provided.
public Nullable<bool> ApiKeyRequired { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
Authorizer
(experimental) The authorize to this route.
public IWebSocketRouteAuthorizer Authorizer { get; set; }
Property Value
Remarks
You can only set authorizer to a $connect route.
Default: - No Authorizer
Stability: Experimental
Integration
(experimental) The integration to be configured on this route.
public WebSocketRouteIntegration Integration { get; set; }
Property Value
Remarks
Stability: Experimental
RouteKey
(experimental) The key to this route.
public string RouteKey { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
WebSocketApi
(experimental) The API the route is associated with.
public IWebSocketApi WebSocketApi { get; set; }
Property Value
Remarks
Stability: Experimental