Package software.amazon.awscdk.aws_apigatewayv2_authorizers

Class WebSocketLambdaAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.aws_apigatewayv2_authorizers.WebSocketLambdaAuthorizer

All Implemented Interfaces:

IWebSocketRouteAuthorizer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:52.737Z")
@Stability(Stable)
public class WebSocketLambdaAuthorizer
extends software.amazon.jsii.JsiiObject
implements IWebSocketRouteAuthorizer

Authorize WebSocket Api routes via a lambda function.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_authorizers.WebSocketLambdaAuthorizer;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.WebSocketLambdaIntegration;
 // This function handles your auth logic
 Function authHandler;
 // This function handles your WebSocket requests
 Function handler;
 WebSocketLambdaAuthorizer authorizer = new WebSocketLambdaAuthorizer("Authorizer", authHandler);
 WebSocketLambdaIntegration integration = new WebSocketLambdaIntegration("Integration", handler);
 WebSocketApi.Builder.create(this, "WebSocketApi")
         .connectRouteOptions(WebSocketRouteOptions.builder()
                 .integration(integration)
                 .authorizer(authorizer)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WebSocketLambdaAuthorizer.Builder	A fluent builder for WebSocketLambdaAuthorizer.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketRouteAuthorizer

IWebSocketRouteAuthorizer.Jsii$Default, IWebSocketRouteAuthorizer.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	WebSocketLambdaAuthorizer(String id, IFunction handler)
	WebSocketLambdaAuthorizer(String id, IFunction handler, WebSocketLambdaAuthorizerProps props)
protected	WebSocketLambdaAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketLambdaAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
WebSocketRouteAuthorizerConfig	bind(WebSocketRouteAuthorizerBindOptions options)	Bind this authorizer to a specified WebSocket route.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

WebSocketLambdaAuthorizer

protected WebSocketLambdaAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)

WebSocketLambdaAuthorizer

protected WebSocketLambdaAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

WebSocketLambdaAuthorizer

@Stability(Stable)
public WebSocketLambdaAuthorizer(@NotNull
 String id,
 @NotNull
 IFunction handler,
 @Nullable
 WebSocketLambdaAuthorizerProps props)

Parameters:

id - This parameter is required.

handler - This parameter is required.

props -

WebSocketLambdaAuthorizer

@Stability(Stable)
public WebSocketLambdaAuthorizer(@NotNull
 String id,
 @NotNull
 IFunction handler)

Parameters:

id - This parameter is required.

handler - This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public WebSocketRouteAuthorizerConfig bind(@NotNull
 WebSocketRouteAuthorizerBindOptions options)

Bind this authorizer to a specified WebSocket route.

Specified by:

bind in interface IWebSocketRouteAuthorizer

Parameters:

options - This parameter is required.