Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketRouteAuthorizerConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketRouteAuthorizerConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.352Z")
@Stability(Experimental)
public interface WebSocketRouteAuthorizerConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Results of binding an authorizer to an WebSocket route.

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.*;
 WebSocketRouteAuthorizerConfig webSocketRouteAuthorizerConfig = WebSocketRouteAuthorizerConfig.builder()
         .authorizationType("authorizationType")
         // the properties below are optional
         .authorizerId("authorizerId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WebSocketRouteAuthorizerConfig.Builder	A builder for WebSocketRouteAuthorizerConfig
static final class	WebSocketRouteAuthorizerConfig.Jsii$Proxy	An implementation for WebSocketRouteAuthorizerConfig

Method Summary

Modifier and Type	Method	Description
static WebSocketRouteAuthorizerConfig.Builder	builder()
String	getAuthorizationType()	(experimental) The type of authorization.
default String	getAuthorizerId()	(experimental) The authorizer id.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationType

@Stability(Experimental)
@NotNull
String getAuthorizationType()

(experimental) The type of authorization.

Possible values are:

• CUSTOM - Lambda Authorizer
• NONE - No Authorization

getAuthorizerId

@Stability(Experimental)
@Nullable
default String getAuthorizerId()

(experimental) The authorizer id.

Default: - No authorizer id (useful for AWS_IAM route authorizer)

builder

@Stability(Experimental)
static WebSocketRouteAuthorizerConfig.Builder builder()

Returns:

a WebSocketRouteAuthorizerConfig.Builder of WebSocketRouteAuthorizerConfig