Interface IWebSocketRouteProps

Properties to initialize a new Route.

Inherited Members

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IWebSocketRouteProps : IWebSocketRouteOptions

Syntax (vb)

Public Interface IWebSocketRouteProps Inherits IWebSocketRouteOptions

Remarks

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

Synopsis

Properties

ApiKeyRequired	Whether the route requires an API Key to be provided.
RouteKey	The key to this route.
WebSocketApi	The API the route is associated with.

Properties

ApiKeyRequired

Whether the route requires an API Key to be provided.

bool? ApiKeyRequired { get; }

Property Value

bool?

Remarks

Default: false

RouteKey

The key to this route.

string RouteKey { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

WebSocketApi

The API the route is associated with.

IWebSocketApi WebSocketApi { get; }

Property Value

IWebSocketApi

Remarks

ExampleMetadata: fixture=_generated