Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketApiProps.Jsii$Proxy

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

(experimental) Props for WebSocket API.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WebSocketApiProps.Builder	builder()
default WebSocketApiKeySelectionExpression	getApiKeySelectionExpression()	(experimental) An API key selection expression.
default 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 String	getDescription()	(experimental) The description of the API.
default WebSocketRouteOptions	getDisconnectRouteOptions()	(experimental) Options to configure a '$disconnect' route.
default String	getRouteSelectionExpression()	(experimental) The route selection expression for the API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKeySelectionExpression

@Stability(Experimental)
@Nullable
default WebSocketApiKeySelectionExpression getApiKeySelectionExpression()

(experimental) An API key selection expression.

Providing this option will require an API Key be provided to access the API.

Default: - Key is not required to access these APIs

getApiName

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

(experimental) Name for the WebSocket API resource.

Default: - id of the WebSocketApi construct.

getConnectRouteOptions

@Stability(Experimental)
@Nullable
default WebSocketRouteOptions getConnectRouteOptions()

(experimental) Options to configure a '$connect' route.

Default: - no '$connect' route configured

getDefaultRouteOptions

@Stability(Experimental)
@Nullable
default WebSocketRouteOptions getDefaultRouteOptions()

(experimental) Options to configure a '$default' route.

Default: - no '$default' route configured

getDescription

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

(experimental) The description of the API.

Default: - none

getDisconnectRouteOptions

@Stability(Experimental)
@Nullable
default WebSocketRouteOptions getDisconnectRouteOptions()

(experimental) Options to configure a '$disconnect' route.

Default: - no '$disconnect' route configured

getRouteSelectionExpression

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

(experimental) The route selection expression for the API.

Default: '$request.body.action'

builder

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

Returns:

a WebSocketApiProps.Builder of WebSocketApiProps