aws-cdk-lib.aws_apigatewayv2.WebSocketRouteAuthorizerBindOptions

WebSocketRouteAuthorizerBindOptions Struct

Input to the bind() operation, that binds an authorizer to a route.

Source

aws-apigatewayv2/lib/websocket/authorizer.ts

Type last changed

v2.112.0 · 1 Dec 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import * as constructs from 'constructs';

declare const construct: constructs.Construct;
declare const webSocketRoute: apigatewayv2.WebSocketRoute;
const webSocketRouteAuthorizerBindOptions: apigatewayv2.WebSocketRouteAuthorizerBindOptions = {
  route: webSocketRoute,
  scope: construct,
};

Properties

routeIWebSocketRouterouteIWebSocketRouterouteIWebSocketRouteRouteIWebSocketRouteRouteIWebSocketRouterequired#

The route to which the authorizer is being bound.

scopeConstructscopeConstructscopeConstructScopeConstructScopeConstructrequired#

The scope for any constructs created as part of the bind.