@aws-cdk_aws-apigatewayv2-alpha.WebSocketRouteProps

interface WebSocketRouteProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.WebSocketRouteProps
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#WebSocketRouteProps
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.WebSocketRouteProps
Pythonaws_cdk.aws_apigatewayv2_alpha.WebSocketRouteProps
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป WebSocketRouteProps

Properties to initialize a new Route.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2_alpha from '@aws-cdk/aws-apigatewayv2-alpha';

declare const webSocketApi: apigatewayv2_alpha.WebSocketApi;
declare const webSocketRouteAuthorizer: apigatewayv2_alpha.IWebSocketRouteAuthorizer;
declare const webSocketRouteIntegration: apigatewayv2_alpha.WebSocketRouteIntegration;
const webSocketRouteProps: apigatewayv2_alpha.WebSocketRouteProps = {
  integration: webSocketRouteIntegration,
  routeKey: 'routeKey',
  webSocketApi: webSocketApi,

  // the properties below are optional
  apiKeyRequired: false,
  authorizer: webSocketRouteAuthorizer,
  returnResponse: false,
};

Properties

NameTypeDescription
integration๐Ÿ”นWebSocketRouteIntegrationThe integration to be configured on this route.
routeKey๐Ÿ”นstringThe key to this route.
webSocketApi๐Ÿ”นIWebSocketApiThe API the route is associated with.
apiKeyRequired?๐Ÿ”นbooleanWhether the route requires an API Key to be provided.
authorizer?๐Ÿ”นIWebSocketRouteAuthorizerThe authorize to this route.
returnResponse?๐Ÿ”นbooleanShould the route send a response to the client.

integration๐Ÿ”น

Type: WebSocketRouteIntegration

The integration to be configured on this route.


routeKey๐Ÿ”น

Type: string

The key to this route.


webSocketApi๐Ÿ”น

Type: IWebSocketApi

The API the route is associated with.


apiKeyRequired?๐Ÿ”น

Type: boolean (optional, default: false)

Whether the route requires an API Key to be provided.


authorizer?๐Ÿ”น

Type: IWebSocketRouteAuthorizer (optional, default: No Authorizer)

The authorize to this route.

You can only set authorizer to a $connect route.


returnResponse?๐Ÿ”น

Type: boolean (optional, default: false)

Should the route send a response to the client.