Package 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.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:03.951Z")
@Stability(Stable)
public interface StageOptions
extends software.amazon.jsii.JsiiSerializable

Options required to create a new stage.

Options that are common between HTTP and Websocket APIs.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 import software.amazon.awscdk.interfaces.apigatewayv2.*;
 IAccessLogSettings accessLogSettings;
 IDomainNameRef domainNameRef;
 StageOptions stageOptions = StageOptions.builder()
         .accessLogSettings(accessLogSettings)
         .autoDeploy(false)
         .description("description")
         .detailedMetricsEnabled(false)
         .domainMapping(DomainMappingOptions.builder()
                 .domainName(domainNameRef)
                 // the properties below are optional
                 .mappingKey("mappingKey")
                 .build())
         .stageVariables(Map.of(
                 "stageVariablesKey", "stageVariables"))
         .throttle(ThrottleSettings.builder()
                 .burstLimit(123)
                 .rateLimit(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StageOptions.Builder	builder()
default IAccessLogSettings	getAccessLogSettings()	Settings for access logging.
default Boolean	getAutoDeploy()	Whether updates to an API automatically trigger a new deployment.
default String	getDescription()	The description for the API stage.
default Boolean	getDetailedMetricsEnabled()	Specifies whether detailed metrics are enabled.
default DomainMappingOptions	getDomainMapping()	The options for custom domain and api mapping.
default Map<String,String>	getStageVariables()	Stage variables for the stage.
default ThrottleSettings	getThrottle()	Throttle settings for the routes of this stage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessLogSettings

@Stability(Stable)
@Nullable
default IAccessLogSettings getAccessLogSettings()

Settings for access logging.

Default: - No access logging

getAutoDeploy

@Stability(Stable)
@Nullable
default Boolean getAutoDeploy()

Whether updates to an API automatically trigger a new deployment.

Default: false

getDescription

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

The description for the API stage.

Default: - no description

getDetailedMetricsEnabled

@Stability(Stable)
@Nullable
default Boolean getDetailedMetricsEnabled()

Specifies whether detailed metrics are enabled.

Default: false

getDomainMapping

@Stability(Stable)
@Nullable
default DomainMappingOptions getDomainMapping()

The options for custom domain and api mapping.

Default: - no custom domain and api mapping configuration

getStageVariables

@Stability(Stable)
@Nullable
default Map<String,String> getStageVariables()

Stage variables for the stage. These are key-value pairs that you can define and use in your API routes.

The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables

Default: - No stage variables

getThrottle

@Stability(Stable)
@Nullable
default ThrottleSettings getThrottle()

Throttle settings for the routes of this stage.

Default: - no throttling configuration

builder

@Stability(Stable)
static StageOptions.Builder builder()

Returns:

a StageOptions.Builder of StageOptions