Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketIntegration.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketIntegration>

Enclosing class:

WebSocketIntegration

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

A fluent builder for WebSocketIntegration.

Method Summary

Modifier and Type	Method	Description
WebSocketIntegration	build()
static WebSocketIntegration.Builder	create(software.constructs.Construct scope, String id)
WebSocketIntegration.Builder	integrationType(WebSocketIntegrationType integrationType)	Integration type.
WebSocketIntegration.Builder	integrationUri(String integrationUri)	Integration URI.
WebSocketIntegration.Builder	webSocketApi(IWebSocketApi webSocketApi)	The WebSocket API to which this integration should be bound.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of WebSocketIntegration.Builder.

integrationType

@Stability(Stable)
public WebSocketIntegration.Builder integrationType(WebSocketIntegrationType integrationType)

Integration type.

Parameters:

integrationType - Integration type. This parameter is required.

Returns:

this

integrationUri

@Stability(Stable)
public WebSocketIntegration.Builder integrationUri(String integrationUri)

Integration URI.

Parameters:

integrationUri - Integration URI. This parameter is required.

Returns:

this

webSocketApi

@Stability(Stable)
public WebSocketIntegration.Builder webSocketApi(IWebSocketApi webSocketApi)

The WebSocket API to which this integration should be bound.

Parameters:

webSocketApi - The WebSocket API to which this integration should be bound. This parameter is required.

Returns:

this

build

@Stability(Stable)
public WebSocketIntegration build()

Specified by:

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

Returns:

a newly built instance of WebSocketIntegration.