software.amazon.awscdk.services.apigatewayv2

Interface StageOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

HttpStageOptions, HttpStageProps, WebSocketStageProps

All Known Implementing Classes:

HttpStageOptions.Jsii$Proxy, HttpStageProps.Jsii$Proxy, StageOptions.Jsii$Proxy, WebSocketStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:21.443Z")
 @Stability(value=Experimental)
public interface StageOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options required to create a new stage.

Options that are common between HTTP and Websocket APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StageOptions.Builder A builder for StageOptions
static class	StageOptions.Jsii$Proxy An implementation for StageOptions

Method Summary

Modifier and Type	Method and Description
static StageOptions.Builder	builder()
default Boolean	getAutoDeploy() (experimental) Whether updates to an API automatically trigger a new deployment.
default DomainMappingOptions	getDomainMapping() (experimental) The options for custom domain and api mapping.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoDeploy

@Stability(value=Experimental)
 @Nullable
default Boolean getAutoDeploy()

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

Default: false

getDomainMapping

@Stability(value=Experimental)
 @Nullable
default DomainMappingOptions getDomainMapping()

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

Default: - no custom domain and api mapping configuration

builder

@Stability(value=Experimental)
static StageOptions.Builder builder()

Returns:

a StageOptions.Builder of StageOptions