software.amazon.awscdk.services.apigatewayv2

Class WebSocketStage.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketStage.Builder

Enclosing class:

WebSocketStage

public static final class WebSocketStage.Builder
extends java.lang.Object

(experimental) A fluent builder for WebSocketStage.

Method Summary

Modifier and Type	Method and Description
WebSocketStage.Builder	autoDeploy(java.lang.Boolean autoDeploy) (experimental) Whether updates to an API automatically trigger a new deployment.
WebSocketStage	build()
static WebSocketStage.Builder	create(software.constructs.Construct scope, java.lang.String id)
WebSocketStage.Builder	domainMapping(DomainMappingOptions domainMapping) (experimental) The options for custom domain and api mapping.
WebSocketStage.Builder	stageName(java.lang.String stageName) (experimental) The name of the stage.
WebSocketStage.Builder	throttle(ThrottleSettings throttle) (experimental) Throttle settings for the routes of this stage.
WebSocketStage.Builder	webSocketApi(IWebSocketApi webSocketApi) (experimental) The WebSocket API to which this stage is associated.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static WebSocketStage.Builder create(software.constructs.Construct scope,
                                            java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of WebSocketStage.Builder.

autoDeploy

public WebSocketStage.Builder autoDeploy(java.lang.Boolean autoDeploy)

(experimental) Whether updates to an API automatically trigger a new deployment.

Default: false

Parameters:

autoDeploy - Whether updates to an API automatically trigger a new deployment. This parameter is required.

Returns:

this

domainMapping

public WebSocketStage.Builder domainMapping(DomainMappingOptions domainMapping)

(experimental) The options for custom domain and api mapping.

Default: - no custom domain and api mapping configuration

Parameters:

domainMapping - The options for custom domain and api mapping. This parameter is required.

Returns:

this

throttle

public WebSocketStage.Builder throttle(ThrottleSettings throttle)

(experimental) Throttle settings for the routes of this stage.

Default: - no throttling configuration

Parameters:

throttle - Throttle settings for the routes of this stage. This parameter is required.

Returns:

this

stageName

public WebSocketStage.Builder stageName(java.lang.String stageName)

(experimental) The name of the stage.

Parameters:

stageName - The name of the stage. This parameter is required.

Returns:

this

webSocketApi

public WebSocketStage.Builder webSocketApi(IWebSocketApi webSocketApi)

(experimental) The WebSocket API to which this stage is associated.

Parameters:

webSocketApi - The WebSocket API to which this stage is associated. This parameter is required.

Returns:

this

build

public WebSocketStage build()