Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketApiAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketApiAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketApiAttributes>

Enclosing interface:

WebSocketApiAttributes

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

A builder for WebSocketApiAttributes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WebSocketApiAttributes.Builder	apiEndpoint(String apiEndpoint)	Sets the value of WebSocketApiAttributes.getApiEndpoint()
WebSocketApiAttributes	build()	Builds the configured instance.
WebSocketApiAttributes.Builder	webSocketId(String webSocketId)	Sets the value of WebSocketApiAttributes.getWebSocketId()

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

webSocketId

@Stability(Stable)
public WebSocketApiAttributes.Builder webSocketId(String webSocketId)

Sets the value of WebSocketApiAttributes.getWebSocketId()

Parameters:

webSocketId - The identifier of the WebSocketApi. This parameter is required.

Returns:

this

apiEndpoint

@Stability(Stable)
public WebSocketApiAttributes.Builder apiEndpoint(String apiEndpoint)

Sets the value of WebSocketApiAttributes.getApiEndpoint()

Parameters:

apiEndpoint - The endpoint URL of the WebSocketApi.

Returns:

this

build

@Stability(Stable)
public WebSocketApiAttributes build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of WebSocketApiAttributes

Throws:

NullPointerException - if any required attribute was not provided