Class WebSocketStage.Builder
java.lang.Object
software.amazon.awscdk.services.apigatewayv2.WebSocketStage.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<WebSocketStage>
- Enclosing class:
WebSocketStage
@Stability(Experimental)
public static final class WebSocketStage.Builder
extends Object
implements software.amazon.jsii.Builder<WebSocketStage>
(experimental) A fluent builder for
WebSocketStage
.-
Method Summary
Modifier and TypeMethodDescriptionautoDeploy
(Boolean autoDeploy) (experimental) Whether updates to an API automatically trigger a new deployment.build()
static WebSocketStage.Builder
domainMapping
(DomainMappingOptions domainMapping) (experimental) The options for custom domain and api mapping.(experimental) The name of the stage.throttle
(ThrottleSettings throttle) (experimental) Throttle settings for the routes of this stage.webSocketApi
(IWebSocketApi webSocketApi) (experimental) The WebSocket API to which this stage is associated.
-
Method Details
-
create
@Stability(Experimental) public static WebSocketStage.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
WebSocketStage.Builder
.
-
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
@Stability(Experimental) 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
(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
(experimental) The name of the stage.- Parameters:
stageName
- The name of the stage. This parameter is required.- Returns:
this
-
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
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<WebSocketStage>
- Returns:
- a newly built instance of
WebSocketStage
.
-