Package software.amazon.awscdk.services.apigatewayv2

Interface HttpStageOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, StageOptions

All Known Subinterfaces:

HttpStageProps

All Known Implementing Classes:

HttpStageOptions.Jsii$Proxy, HttpStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:03.685Z")
@Stability(Stable)
public interface HttpStageOptions
extends software.amazon.jsii.JsiiSerializable, StageOptions

The options to create a new Stage for an HTTP API.

Example:

 HttpApi api;
 DomainName dn;
 api.addStage("beta", HttpStageOptions.builder()
         .stageName("beta")
         .autoDeploy(true)
         // https://${dn.domainName}/bar goes to the beta stage
         .domainMapping(DomainMappingOptions.builder()
                 .domainName(dn)
                 .mappingKey("bar")
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpStageOptions.Builder	builder()
default String	getStageName()	The name of the stage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.StageOptions

getAutoDeploy, getDescription, getDomainMapping, getThrottle

Method Details

getStageName

@Stability(Stable)
@Nullable
default String getStageName()

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(Stable)
static HttpStageOptions.Builder builder()

Returns:

a HttpStageOptions.Builder of HttpStageOptions