Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketApiProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketApiProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketApiProps>

Enclosing interface:

WebSocketApiProps

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

A builder for WebSocketApiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WebSocketApiProps.Builder	apiKeySelectionExpression(WebSocketApiKeySelectionExpression apiKeySelectionExpression)	Sets the value of WebSocketApiProps.getApiKeySelectionExpression()
WebSocketApiProps.Builder	apiName(String apiName)	Sets the value of WebSocketApiProps.getApiName()
WebSocketApiProps	build()	Builds the configured instance.
WebSocketApiProps.Builder	connectRouteOptions(WebSocketRouteOptions connectRouteOptions)	Sets the value of WebSocketApiProps.getConnectRouteOptions()
WebSocketApiProps.Builder	defaultRouteOptions(WebSocketRouteOptions defaultRouteOptions)	Sets the value of WebSocketApiProps.getDefaultRouteOptions()
WebSocketApiProps.Builder	description(String description)	Sets the value of WebSocketApiProps.getDescription()
WebSocketApiProps.Builder	disableSchemaValidation(Boolean disableSchemaValidation)	Sets the value of WebSocketApiProps.getDisableSchemaValidation()
WebSocketApiProps.Builder	disconnectRouteOptions(WebSocketRouteOptions disconnectRouteOptions)	Sets the value of WebSocketApiProps.getDisconnectRouteOptions()
WebSocketApiProps.Builder	ipAddressType(IpAddressType ipAddressType)	Sets the value of WebSocketApiProps.getIpAddressType()
WebSocketApiProps.Builder	routeSelectionExpression(String routeSelectionExpression)	Sets the value of WebSocketApiProps.getRouteSelectionExpression()

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

apiKeySelectionExpression

@Stability(Stable)
public WebSocketApiProps.Builder apiKeySelectionExpression(WebSocketApiKeySelectionExpression apiKeySelectionExpression)

Sets the value of WebSocketApiProps.getApiKeySelectionExpression()

Parameters:

apiKeySelectionExpression - An API key selection expression. Providing this option will require an API Key be provided to access the API.

Returns:

this

apiName

@Stability(Stable)
public WebSocketApiProps.Builder apiName(String apiName)

Sets the value of WebSocketApiProps.getApiName()

Parameters:

apiName - Name for the WebSocket API resource.

Returns:

this

connectRouteOptions

@Stability(Stable)
public WebSocketApiProps.Builder connectRouteOptions(WebSocketRouteOptions connectRouteOptions)

Sets the value of WebSocketApiProps.getConnectRouteOptions()

Parameters:

connectRouteOptions - Options to configure a '$connect' route.

Returns:

this

defaultRouteOptions

@Stability(Stable)
public WebSocketApiProps.Builder defaultRouteOptions(WebSocketRouteOptions defaultRouteOptions)

Sets the value of WebSocketApiProps.getDefaultRouteOptions()

Parameters:

defaultRouteOptions - Options to configure a '$default' route.

Returns:

this

description

@Stability(Stable)
public WebSocketApiProps.Builder description(String description)

Sets the value of WebSocketApiProps.getDescription()

Parameters:

description - The description of the API.

Returns:

this

disableSchemaValidation

@Stability(Stable)
public WebSocketApiProps.Builder disableSchemaValidation(Boolean disableSchemaValidation)

Sets the value of WebSocketApiProps.getDisableSchemaValidation()

Parameters:

disableSchemaValidation - Avoid validating models when creating a deployment.

Returns:

this

disconnectRouteOptions

@Stability(Stable)
public WebSocketApiProps.Builder disconnectRouteOptions(WebSocketRouteOptions disconnectRouteOptions)

Sets the value of WebSocketApiProps.getDisconnectRouteOptions()

Parameters:

disconnectRouteOptions - Options to configure a '$disconnect' route.

Returns:

this

ipAddressType

@Stability(Stable)
public WebSocketApiProps.Builder ipAddressType(IpAddressType ipAddressType)

Sets the value of WebSocketApiProps.getIpAddressType()

Parameters:

ipAddressType - The IP address types that can invoke the API.

Returns:

this

routeSelectionExpression

@Stability(Stable)
public WebSocketApiProps.Builder routeSelectionExpression(String routeSelectionExpression)

Sets the value of WebSocketApiProps.getRouteSelectionExpression()

Parameters:

routeSelectionExpression - The route selection expression for the API.

Returns:

this

build

@Stability(Stable)
public WebSocketApiProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of WebSocketApiProps

Throws:

NullPointerException - if any required attribute was not provided