software.amazon.awscdk.services.apigatewayv2.alpha

Class WebSocketApi.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketApi>

Enclosing class:

WebSocketApi

@Stability(value=Experimental)
public static final class WebSocketApi.Builder
extends Object
implements software.amazon.jsii.Builder<WebSocketApi>

(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(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, String id)
WebSocketApi.Builder	defaultRouteOptions(WebSocketRouteOptions defaultRouteOptions) (experimental) Options to configure a '$default' route.
WebSocketApi.Builder	description(String description) (experimental) The description of the API.
WebSocketApi.Builder	disconnectRouteOptions(WebSocketRouteOptions disconnectRouteOptions) (experimental) Options to configure a '$disconnect' route.
WebSocketApi.Builder	routeSelectionExpression(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

@Stability(value=Experimental)
public static WebSocketApi.Builder create(software.constructs.Construct scope,
                                                                         String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of WebSocketApi.Builder.

apiKeySelectionExpression

@Stability(value=Experimental)
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

@Stability(value=Experimental)
public WebSocketApi.Builder apiName(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

@Stability(value=Experimental)
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

@Stability(value=Experimental)
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

@Stability(value=Experimental)
public WebSocketApi.Builder description(String description)

(experimental) The description of the API.

Default: - none

Parameters:

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

Returns:

this

disconnectRouteOptions

@Stability(value=Experimental)
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

@Stability(value=Experimental)
public WebSocketApi.Builder routeSelectionExpression(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

@Stability(value=Experimental)
public WebSocketApi build()

Specified by:

build in interface software.amazon.jsii.Builder<WebSocketApi>