Interface WebSocketAuthorizerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
WebSocketAuthorizerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:43.346Z")
@Stability(Experimental)
public interface WebSocketAuthorizerProps
extends software.amazon.jsii.JsiiSerializable
(experimental) Properties to initialize an instance of
WebSocketAuthorizer
.
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; WebSocketAuthorizerProps webSocketAuthorizerProps = WebSocketAuthorizerProps.builder() .identitySource(List.of("identitySource")) .type(WebSocketAuthorizerType.LAMBDA) .webSocketApi(webSocketApi) // the properties below are optional .authorizerName("authorizerName") .authorizerUri("authorizerUri") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forWebSocketAuthorizerProps
static final class
An implementation forWebSocketAuthorizerProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
(experimental) Name of the authorizer.default String
(experimental) The authorizer's Uniform Resource Identifier (URI).(experimental) The identity source for which authorization is requested.getType()
(experimental) The type of authorizer.(experimental) WebSocket Api to attach the authorizer to.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIdentitySource
(experimental) The identity source for which authorization is requested.- See Also:
-
getType
(experimental) The type of authorizer. -
getWebSocketApi
(experimental) WebSocket Api to attach the authorizer to. -
getAuthorizerName
(experimental) Name of the authorizer.Default: - id of the WebSocketAuthorizer construct.
-
getAuthorizerUri
(experimental) The authorizer's Uniform Resource Identifier (URI).For REQUEST authorizers, this must be a well-formed Lambda function URI.
Default: - required for Request authorizer types
-
builder
- Returns:
- a
WebSocketAuthorizerProps.Builder
ofWebSocketAuthorizerProps
-