Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigatewayv2.WebSocketAuthorizer

All Implemented Interfaces:

IEnvironmentAware, IResource, IAuthorizer, IWebSocketAuthorizer, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:33.694Z")
@Stability(Stable)
public class WebSocketAuthorizer
extends Resource
implements IWebSocketAuthorizer

An authorizer for WebSocket Apis.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 WebSocketApi webSocketApi;
 WebSocketAuthorizer webSocketAuthorizer = WebSocketAuthorizer.Builder.create(this, "MyWebSocketAuthorizer")
         .identitySource(List.of("identitySource"))
         .type(WebSocketAuthorizerType.LAMBDA)
         .webSocketApi(webSocketApi)
         // the properties below are optional
         .authorizerName("authorizerName")
         .authorizerUri("authorizerUri")
         .build();
 

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

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

IWebSocketAuthorizer.Jsii$Default, IWebSocketAuthorizer.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebSocketAuthorizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketAuthorizer(software.amazon.jsii.JsiiObjectRef objRef)
	WebSocketAuthorizer(software.constructs.Construct scope, String id, WebSocketAuthorizerProps props)

Method Summary

Modifier and Type	Method	Description
static IWebSocketRouteAuthorizer	fromWebSocketAuthorizerAttributes(software.constructs.Construct scope, String id, WebSocketAuthorizerAttributes attrs)	Import an existing WebSocket Authorizer into this CDK app.
String	getAuthorizerId()	Id of the Authorizer.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

WebSocketAuthorizer

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

WebSocketAuthorizer

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

WebSocketAuthorizer

@Stability(Stable)
public WebSocketAuthorizer(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 WebSocketAuthorizerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromWebSocketAuthorizerAttributes

@Stability(Stable)
@NotNull
public static IWebSocketRouteAuthorizer fromWebSocketAuthorizerAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 WebSocketAuthorizerAttributes attrs)

Import an existing WebSocket Authorizer into this CDK app.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getAuthorizerId

@Stability(Stable)
@NotNull
public String getAuthorizerId()

Id of the Authorizer.

Specified by:

getAuthorizerId in interface IAuthorizer