Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketRoute.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketRoute.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketRoute>

Enclosing class:

WebSocketRoute

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

(experimental) A fluent builder for WebSocketRoute.

Method Summary

Modifier and Type	Method	Description
WebSocketRoute.Builder	apiKeyRequired(Boolean apiKeyRequired)	(experimental) Whether the route requires an API Key to be provided.
WebSocketRoute.Builder	authorizer(IWebSocketRouteAuthorizer authorizer)	(experimental) The authorize to this route.
WebSocketRoute	build()
static WebSocketRoute.Builder	create(software.constructs.Construct scope, String id)
WebSocketRoute.Builder	integration(WebSocketRouteIntegration integration)	(experimental) The integration to be configured on this route.
WebSocketRoute.Builder	routeKey(String routeKey)	(experimental) The key to this route.
WebSocketRoute.Builder	webSocketApi(IWebSocketApi webSocketApi)	(experimental) The API the route is associated with.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of WebSocketRoute.Builder.

integration

@Stability(Experimental)
public WebSocketRoute.Builder integration(WebSocketRouteIntegration integration)

(experimental) The integration to be configured on this route.

Parameters:

integration - The integration to be configured on this route. This parameter is required.

Returns:

this

authorizer

@Stability(Experimental)
public WebSocketRoute.Builder authorizer(IWebSocketRouteAuthorizer authorizer)

(experimental) The authorize to this route.

You can only set authorizer to a $connect route.

Default: - No Authorizer

Parameters:

authorizer - The authorize to this route. This parameter is required.

Returns:

this

routeKey

@Stability(Experimental)
public WebSocketRoute.Builder routeKey(String routeKey)

(experimental) The key to this route.

Parameters:

routeKey - The key to this route. This parameter is required.

Returns:

this

webSocketApi

@Stability(Experimental)
public WebSocketRoute.Builder webSocketApi(IWebSocketApi webSocketApi)

(experimental) The API the route is associated with.

Parameters:

webSocketApi - The API the route is associated with. This parameter is required.

Returns:

this

apiKeyRequired

@Stability(Experimental)
public WebSocketRoute.Builder apiKeyRequired(Boolean apiKeyRequired)

(experimental) Whether the route requires an API Key to be provided.

Default: false

Parameters:

apiKeyRequired - Whether the route requires an API Key to be provided. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public WebSocketRoute build()

Specified by:

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

Returns:

a newly built instance of WebSocketRoute.