@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
date="2022-06-22T23:27:58.343Z")
public interface WebSocketApiProps
Example:
import software.amazon.awscdk.services.apigatewayv2.authorizers.WebSocketLambdaAuthorizer; import software.amazon.awscdk.services.apigatewayv2.integrations.WebSocketLambdaIntegration; // This function handles your auth logic Function authHandler; // This function handles your WebSocket requests Function handler; WebSocketLambdaAuthorizer authorizer = new WebSocketLambdaAuthorizer("Authorizer", authHandler); WebSocketLambdaIntegration integration = new WebSocketLambdaIntegration("Integration", handler); WebSocketApi.Builder.create(this, "WebSocketApi") .connectRouteOptions(WebSocketRouteOptions.builder() .integration(integration) .authorizer(authorizer) .build()) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
WebSocketApiProps.Builder
A builder for
WebSocketApiProps |
static class |
WebSocketApiProps.Jsii$Proxy
An implementation for
WebSocketApiProps |
Modifier and Type | Method and Description |
---|---|
static WebSocketApiProps.Builder |
builder() |
default WebSocketApiKeySelectionExpression |
getApiKeySelectionExpression()
(experimental) An API key selection expression.
|
default java.lang.String |
getApiName()
(experimental) Name for the WebSocket API resource.
|
default WebSocketRouteOptions |
getConnectRouteOptions()
(experimental) Options to configure a '$connect' route.
|
default WebSocketRouteOptions |
getDefaultRouteOptions()
(experimental) Options to configure a '$default' route.
|
default java.lang.String |
getDescription()
(experimental) The description of the API.
|
default WebSocketRouteOptions |
getDisconnectRouteOptions()
(experimental) Options to configure a '$disconnect' route.
|
default java.lang.String |
getRouteSelectionExpression()
(experimental) The route selection expression for the API.
|
default WebSocketApiKeySelectionExpression getApiKeySelectionExpression()
Providing this option will require an API Key be provided to access the API.
Default: - Key is not required to access these APIs
default java.lang.String getApiName()
Default: - id of the WebSocketApi construct.
default WebSocketRouteOptions getConnectRouteOptions()
Default: - no '$connect' route configured
default WebSocketRouteOptions getDefaultRouteOptions()
Default: - no '$default' route configured
default java.lang.String getDescription()
Default: - none
default WebSocketRouteOptions getDisconnectRouteOptions()
Default: - no '$disconnect' route configured
default java.lang.String getRouteSelectionExpression()
Default: '$request.body.action'
static WebSocketApiProps.Builder builder()
WebSocketApiProps.Builder
of WebSocketApiProps