software.amazon.awscdk.services.apigatewayv2

Class WebSocketApi.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketApi.Builder

Enclosing class:

WebSocketApi

public static final class WebSocketApi.Builder
extends java.lang.Object

(experimental) A fluent builder for WebSocketApi.

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static WebSocketApi.Builder create(software.constructs.Construct scope,
                                          java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of WebSocketApi.Builder.

apiKeySelectionExpression

public WebSocketApi.Builder apiKeySelectionExpression(WebSocketApiKeySelectionExpression apiKeySelectionExpression)

(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

Parameters:

apiKeySelectionExpression - An API key selection expression. This parameter is required.

Returns:

this

apiName

public WebSocketApi.Builder apiName(java.lang.String apiName)

(experimental) Name for the WebSocket API resource.

Default: - id of the WebSocketApi construct.

Parameters:

apiName - Name for the WebSocket API resource. This parameter is required.

Returns:

this

connectRouteOptions

public WebSocketApi.Builder connectRouteOptions(WebSocketRouteOptions connectRouteOptions)

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

Default: - no '$connect' route configured

Parameters:

connectRouteOptions - Options to configure a '$connect' route. This parameter is required.

Returns:

this

defaultRouteOptions

public WebSocketApi.Builder defaultRouteOptions(WebSocketRouteOptions defaultRouteOptions)

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

Default: - no '$default' route configured

Parameters:

defaultRouteOptions - Options to configure a '$default' route. This parameter is required.

Returns:

this

description

public WebSocketApi.Builder description(java.lang.String description)

(experimental) The description of the API.

Default: - none

Parameters:

description - The description of the API. This parameter is required.

Returns:

this

disconnectRouteOptions

public WebSocketApi.Builder disconnectRouteOptions(WebSocketRouteOptions disconnectRouteOptions)

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

Default: - no '$disconnect' route configured

Parameters:

disconnectRouteOptions - Options to configure a '$disconnect' route. This parameter is required.

Returns:

this

routeSelectionExpression

public WebSocketApi.Builder routeSelectionExpression(java.lang.String routeSelectionExpression)

(experimental) The route selection expression for the API.

Default: '$request.body.action'

Parameters:

routeSelectionExpression - The route selection expression for the API. This parameter is required.

Returns:

this

build

public WebSocketApi build()