software.amazon.awscdk.services.apigatewayv2

Class WebSocketAuthorizer

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.WebSocketAuthorizer

All Implemented Interfaces:

IConstruct, IDependable, IResource, IAuthorizer, IWebSocketAuthorizer

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.045Z")
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.*;
 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 interface software.amazon.awscdk.services.apigatewayv2.IWebSocketAuthorizer

IWebSocketAuthorizer.Jsii$Default, IWebSocketAuthorizer.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

WebSocketAuthorizer

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

WebSocketAuthorizer

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

WebSocketAuthorizer

public WebSocketAuthorizer(software.constructs.Construct scope,
                           java.lang.String id,
                           WebSocketAuthorizerProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromWebSocketAuthorizerAttributes

public static IWebSocketRouteAuthorizer fromWebSocketAuthorizerAttributes(software.constructs.Construct scope,
                                                                          java.lang.String id,
                                                                          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

public java.lang.String getAuthorizerId()

(experimental) Id of the Authorizer.

Specified by:

getAuthorizerId in interface IAuthorizer