software.amazon.awscdk.services.apigatewayv2

Interface CommonStageOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

HttpStageOptions, HttpStageProps

All Known Implementing Classes:

CommonStageOptions.Jsii$Proxy, HttpStageOptions.Jsii$Proxy, HttpStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.495Z")
 @Stability(value=Experimental)
public interface CommonStageOptions
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	CommonStageOptions.Builder A builder for CommonStageOptions
static class	CommonStageOptions.Jsii$Proxy An implementation for CommonStageOptions

Method Summary

Modifier and Type	Method and Description
static CommonStageOptions.Builder	builder()
default Boolean	getAutoDeploy() (experimental) Whether updates to an API automatically trigger a new deployment.
default String	getStageName() (experimental) The name of the stage.

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

getStageName

@Stability(value=Experimental)
 @Nullable
default String getStageName()

(experimental) The name of the stage.

See StageName class for more details.

Default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.

builder

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

Returns:

a CommonStageOptions.Builder of CommonStageOptions