public static final class WebSocketApi.Builder
extends java.lang.Object
WebSocketApi
.Modifier and Type | Method and Description |
---|---|
WebSocketApi.Builder |
apiKeySelectionExpression(WebSocketApiKeySelectionExpression apiKeySelectionExpression)
(experimental) An API key selection expression.
|
WebSocketApi.Builder |
apiName(java.lang.String apiName)
(experimental) Name for the WebSocket API resource.
|
WebSocketApi |
build() |
WebSocketApi.Builder |
connectRouteOptions(WebSocketRouteOptions connectRouteOptions)
(experimental) Options to configure a '$connect' route.
|
static WebSocketApi.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
WebSocketApi.Builder |
defaultRouteOptions(WebSocketRouteOptions defaultRouteOptions)
(experimental) Options to configure a '$default' route.
|
WebSocketApi.Builder |
description(java.lang.String description)
(experimental) The description of the API.
|
WebSocketApi.Builder |
disconnectRouteOptions(WebSocketRouteOptions disconnectRouteOptions)
(experimental) Options to configure a '$disconnect' route.
|
WebSocketApi.Builder |
routeSelectionExpression(java.lang.String routeSelectionExpression)
(experimental) The route selection expression for the API.
|
public static WebSocketApi.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.WebSocketApi.Builder
.public WebSocketApi.Builder apiKeySelectionExpression(WebSocketApiKeySelectionExpression apiKeySelectionExpression)
Providing this option will require an API Key be provided to access the API.
Default: - Key is not required to access these APIs
apiKeySelectionExpression
- An API key selection expression. This parameter is required.this
public WebSocketApi.Builder apiName(java.lang.String apiName)
Default: - id of the WebSocketApi construct.
apiName
- Name for the WebSocket API resource. This parameter is required.this
public WebSocketApi.Builder connectRouteOptions(WebSocketRouteOptions connectRouteOptions)
Default: - no '$connect' route configured
connectRouteOptions
- Options to configure a '$connect' route. This parameter is required.this
public WebSocketApi.Builder defaultRouteOptions(WebSocketRouteOptions defaultRouteOptions)
Default: - no '$default' route configured
defaultRouteOptions
- Options to configure a '$default' route. This parameter is required.this
public WebSocketApi.Builder description(java.lang.String description)
Default: - none
description
- The description of the API. This parameter is required.this
public WebSocketApi.Builder disconnectRouteOptions(WebSocketRouteOptions disconnectRouteOptions)
Default: - no '$disconnect' route configured
disconnectRouteOptions
- Options to configure a '$disconnect' route. This parameter is required.this
public WebSocketApi.Builder routeSelectionExpression(java.lang.String routeSelectionExpression)
Default: '$request.body.action'
routeSelectionExpression
- The route selection expression for the API. This parameter is required.this
public WebSocketApi build()