Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketStageProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.WebSocketStageProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WebSocketStageProps>

Enclosing interface:

WebSocketStageProps

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

A builder for WebSocketStageProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WebSocketStageProps.Builder	autoDeploy(Boolean autoDeploy)	Sets the value of StageOptions.getAutoDeploy()
WebSocketStageProps	build()	Builds the configured instance.
WebSocketStageProps.Builder	description(String description)	Sets the value of StageOptions.getDescription()
WebSocketStageProps.Builder	domainMapping(DomainMappingOptions domainMapping)	Sets the value of StageOptions.getDomainMapping()
WebSocketStageProps.Builder	stageName(String stageName)	Sets the value of WebSocketStageProps.getStageName()
WebSocketStageProps.Builder	throttle(ThrottleSettings throttle)	Sets the value of StageOptions.getThrottle()
WebSocketStageProps.Builder	webSocketApi(IWebSocketApi webSocketApi)	Sets the value of WebSocketStageProps.getWebSocketApi()

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

stageName

@Stability(Stable)
public WebSocketStageProps.Builder stageName(String stageName)

Sets the value of WebSocketStageProps.getStageName()

Parameters:

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

Returns:

this

webSocketApi

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

Sets the value of WebSocketStageProps.getWebSocketApi()

Parameters:

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

Returns:

this

autoDeploy

@Stability(Stable)
public WebSocketStageProps.Builder autoDeploy(Boolean autoDeploy)

Sets the value of StageOptions.getAutoDeploy()

Parameters:

autoDeploy - Whether updates to an API automatically trigger a new deployment.

Returns:

this

description

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

Sets the value of StageOptions.getDescription()

Parameters:

description - The description for the API stage.

Returns:

this

domainMapping

@Stability(Stable)
public WebSocketStageProps.Builder domainMapping(DomainMappingOptions domainMapping)

Sets the value of StageOptions.getDomainMapping()

Parameters:

domainMapping - The options for custom domain and api mapping.

Returns:

this

throttle

@Stability(Stable)
public WebSocketStageProps.Builder throttle(ThrottleSettings throttle)

Sets the value of StageOptions.getThrottle()

Parameters:

throttle - Throttle settings for the routes of this stage.

Returns:

this

build

@Stability(Stable)
public WebSocketStageProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of WebSocketStageProps

Throws:

NullPointerException - if any required attribute was not provided