Class WebSocketRoute

(experimental) Route class that creates the Route for API Gateway WebSocket API.

Inheritance
System.Object
Construct
Resource
WebSocketRoute
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class WebSocketRoute : Resource, IWebSocketRoute, IRoute, IResource, IConstruct, IDependable
Syntax (vb)
Public Class WebSocketRoute
    Inherits Resource
    Implements IWebSocketRoute, IRoute, IResource, IConstruct, IDependable
Remarks

Stability: Experimental

Resource: AWS::ApiGatewayV2::Route

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 webSocketRoute = new WebSocketRoute(this, "MyWebSocketRoute", new WebSocketRouteProps {
    Integration = webSocketRouteIntegration,
    RouteKey = "routeKey",
    WebSocketApi = webSocketApi,

    // the properties below are optional
    ApiKeyRequired = false,
    Authorizer = webSocketRouteAuthorizer
});

Synopsis

Constructors

WebSocketRoute(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
WebSocketRoute(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
WebSocketRoute(Construct, String, IWebSocketRouteProps)

Properties

IntegrationResponseId

(experimental) Integration response ID.
RouteId

(experimental) Id of the Route.
RouteKey

(experimental) The key to this route.
WebSocketApi

(experimental) The WebSocket API associated with this route.

Constructors

WebSocketRoute(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected WebSocketRoute(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

WebSocketRoute(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected WebSocketRoute(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

WebSocketRoute(Construct, String, IWebSocketRouteProps)

public WebSocketRoute(Construct scope, string id, IWebSocketRouteProps props)
Parameters
scope Constructs.Construct
id System.String
props IWebSocketRouteProps
Remarks

Stability: Experimental

Properties

IntegrationResponseId

(experimental) Integration response ID.

public virtual string IntegrationResponseId { get; }
Property Value

System.String

Remarks

Stability: Experimental

RouteId

(experimental) Id of the Route.

public virtual string RouteId { get; }
Property Value

System.String

Remarks

Stability: Experimental

RouteKey

(experimental) The key to this route.

public virtual string RouteKey { get; }
Property Value

System.String

Remarks

Stability: Experimental

WebSocketApi

(experimental) The WebSocket API associated with this route.

public virtual IWebSocketApi WebSocketApi { get; }
Property Value

IWebSocketApi

Remarks

Stability: Experimental

Implements

Constructs.IConstruct