Interface StageOptions

All Superinterfaces:
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.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.315Z") @Stability(Experimental) public interface StageOptions extends
(experimental) Options required to create a new stage.

Options that are common between HTTP and Websocket APIs.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 DomainName domainName;
 StageOptions stageOptions = StageOptions.builder()
                 // the properties below are optional
  • Method Details

    • getAutoDeploy

      @Stability(Experimental) @Nullable default Boolean getAutoDeploy()
      (experimental) Whether updates to an API automatically trigger a new deployment.

      Default: false

    • getDomainMapping

      @Stability(Experimental) @Nullable default DomainMappingOptions getDomainMapping()
      (experimental) The options for custom domain and api mapping.

      Default: - no custom domain and api mapping configuration

    • getThrottle

      @Stability(Experimental) @Nullable default ThrottleSettings getThrottle()
      (experimental) Throttle settings for the routes of this stage.

      Default: - no throttling configuration

    • builder

      @Stability(Experimental) static StageOptions.Builder builder()
      a StageOptions.Builder of StageOptions