public static final class WebSocketStage.Builder
extends java.lang.Object
WebSocketStage
.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.
|
public static WebSocketStage.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.WebSocketStage.Builder
.public WebSocketStage.Builder autoDeploy(java.lang.Boolean autoDeploy)
Default: false
autoDeploy
- Whether updates to an API automatically trigger a new deployment. This parameter is required.this
public WebSocketStage.Builder domainMapping(DomainMappingOptions domainMapping)
Default: - no custom domain and api mapping configuration
domainMapping
- The options for custom domain and api mapping. This parameter is required.this
public WebSocketStage.Builder throttle(ThrottleSettings throttle)
Default: - no throttling configuration
throttle
- Throttle settings for the routes of this stage. This parameter is required.this
public WebSocketStage.Builder stageName(java.lang.String stageName)
stageName
- The name of the stage. This parameter is required.this
public WebSocketStage.Builder webSocketApi(IWebSocketApi webSocketApi)
webSocketApi
- The WebSocket API to which this stage is associated. This parameter is required.this
public WebSocketStage build()