Class WebSocketRoute

Route class that creates the Route for API Gateway WebSocket API.

Inheritance
object
Resource
WebSocketRoute
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.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

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,
                 ReturnResponse = false
             });

Synopsis

Constructors

WebSocketRoute(Construct, string, IWebSocketRouteProps)

Route class that creates the Route for API Gateway WebSocket API.

Properties

IntegrationResponseId

Integration response ID.
PROPERTY_INJECTION_ID

Uniquely identifies this class.
RouteId

Id of the Route.
RouteKey

The key to this route.
WebSocketApi

The WebSocket API associated with this route.

Constructors

WebSocketRoute(Construct, string, IWebSocketRouteProps)

Route class that creates the Route for API Gateway WebSocket API.

public WebSocketRoute(Construct scope, string id, IWebSocketRouteProps props)
Parameters
scope Construct
id string
props IWebSocketRouteProps
Remarks

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,
                 ReturnResponse = false
             });

Properties

IntegrationResponseId

Integration response ID.

public virtual string? IntegrationResponseId { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::Route

ExampleMetadata: fixture=_generated

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::Route

ExampleMetadata: fixture=_generated

RouteId

Id of the Route.

public virtual string RouteId { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::Route

ExampleMetadata: fixture=_generated

RouteKey

The key to this route.

public virtual string RouteKey { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::Route

ExampleMetadata: fixture=_generated

WebSocketApi

The WebSocket API associated with this route.

public virtual IWebSocketApi WebSocketApi { get; }
Property Value

IWebSocketApi

Remarks

Resource: AWS::ApiGatewayV2::Route

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable