software.amazon.awscdk.services.apigatewayv2.alpha

Class WebSocketAuthorizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigatewayv2.alpha.WebSocketAuthorizer

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-15T19:53:17.428Z")
 @Stability(value=Experimental)
public class WebSocketAuthorizer
extends Resource
implements IWebSocketAuthorizer

(experimental) 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.alpha.*;
 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 and Description
static class	WebSocketAuthorizer.Builder (experimental) 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.amazon.awscdk.services.apigatewayv2.alpha.IWebSocketAuthorizer

IWebSocketAuthorizer.Jsii$Default, IWebSocketAuthorizer.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static IWebSocketRouteAuthorizer	fromWebSocketAuthorizerAttributes(software.constructs.Construct scope, String id, WebSocketAuthorizerAttributes attrs) (experimental) Import an existing WebSocket Authorizer into this CDK app.
String	getAuthorizerId() (experimental) 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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

WebSocketAuthorizer

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

WebSocketAuthorizer

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

WebSocketAuthorizer

@Stability(value=Experimental)
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 Detail

fromWebSocketAuthorizerAttributes

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

(experimental) 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(value=Experimental)
 @NotNull
public String getAuthorizerId()

(experimental) Id of the Authorizer.

Specified by:

getAuthorizerId in interface IAuthorizer