Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketRouteOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketRouteOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketRouteOptions>

Enclosing interface:

WebSocketRouteOptions

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

A builder for WebSocketRouteOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WebSocketRouteOptions.Builder	authorizer(IWebSocketRouteAuthorizer authorizer)	Sets the value of WebSocketRouteOptions.getAuthorizer()
WebSocketRouteOptions	build()	Builds the configured instance.
WebSocketRouteOptions.Builder	integration(WebSocketRouteIntegration integration)	Sets the value of WebSocketRouteOptions.getIntegration()
WebSocketRouteOptions.Builder	returnResponse(Boolean returnResponse)	Sets the value of WebSocketRouteOptions.getReturnResponse()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

integration

@Stability(Stable)
public WebSocketRouteOptions.Builder integration(WebSocketRouteIntegration integration)

Sets the value of WebSocketRouteOptions.getIntegration()

Parameters:

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

Returns:

this

authorizer

@Stability(Stable)
public WebSocketRouteOptions.Builder authorizer(IWebSocketRouteAuthorizer authorizer)

Sets the value of WebSocketRouteOptions.getAuthorizer()

Parameters:

authorizer - The authorize to this route. You can only set authorizer to a $connect route.

Returns:

this

returnResponse

@Stability(Stable)
public WebSocketRouteOptions.Builder returnResponse(Boolean returnResponse)

Sets the value of WebSocketRouteOptions.getReturnResponse()

Parameters:

returnResponse - Should the route send a response to the client.

Returns:

this

build

@Stability(Stable)
public WebSocketRouteOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of WebSocketRouteOptions

Throws:

NullPointerException - if any required attribute was not provided