Interface HttpStageOptions

All Superinterfaces:, StageOptions
All Known Subinterfaces:
All Known Implementing Classes:
HttpStageOptions.Jsii$Proxy, HttpStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.294Z") @Stability(Experimental) public interface HttpStageOptions extends, StageOptions
(experimental) The options to create a new Stage for an HTTP API.


 HttpApi api;
 DomainName dn;
 api.addStage("beta", HttpStageOptions.builder()
         // https://${dn.domainName}/bar goes to the beta stage
  • Method Details

    • getStageName

      @Stability(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(Experimental) static HttpStageOptions.Builder builder()
      a HttpStageOptions.Builder of HttpStageOptions