Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketRouteAuthorizerBindOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketRouteAuthorizerBindOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.222Z")
@Stability(Stable)
public interface WebSocketRouteAuthorizerBindOptions
extends software.amazon.jsii.JsiiSerializable

Input to the bind() operation, that binds an authorizer to a 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.*;
 import software.constructs.*;
 Construct construct;
 WebSocketRoute webSocketRoute;
 WebSocketRouteAuthorizerBindOptions webSocketRouteAuthorizerBindOptions = WebSocketRouteAuthorizerBindOptions.builder()
         .route(webSocketRoute)
         .scope(construct)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WebSocketRouteAuthorizerBindOptions.Builder	builder()
IWebSocketRoute	getRoute()	The route to which the authorizer is being bound.
software.constructs.Construct	getScope()	The scope for any constructs created as part of the bind.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoute

@Stability(Stable)
@NotNull
IWebSocketRoute getRoute()

The route to which the authorizer is being bound.

getScope

@Stability(Stable)
@NotNull
software.constructs.Construct getScope()

The scope for any constructs created as part of the bind.

builder

@Stability(Stable)
static WebSocketRouteAuthorizerBindOptions.Builder builder()

Returns:

a WebSocketRouteAuthorizerBindOptions.Builder of WebSocketRouteAuthorizerBindOptions