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(value=Experimental)
public static final class WebSocketStageProps.Builder
extends Object
implements software.amazon.jsii.Builder<WebSocketStageProps>

A builder for WebSocketStageProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
WebSocketStageProps.Builder	autoDeploy(Boolean autoDeploy) Sets the value of StageOptions.getAutoDeploy()
WebSocketStageProps	build() Builds the configured instance.
WebSocketStageProps.Builder	domainMapping(DomainMappingOptions domainMapping) Sets the value of StageOptions.getDomainMapping()
WebSocketStageProps.Builder	stageName(String stageName) Sets the value of WebSocketStageProps.getStageName()
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 Detail

Builder

public Builder()

Method Detail

stageName

@Stability(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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

domainMapping

@Stability(value=Experimental)
public WebSocketStageProps.Builder domainMapping(DomainMappingOptions domainMapping)

Sets the value of StageOptions.getDomainMapping()

Parameters:

domainMapping - The options for custom domain and api mapping.

Returns:

this

build

@Stability(value=Experimental)
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