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.103.1 (build bef2dea)",
date="2024-09-11T18:01:10.790Z")
@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.*; DomainName domainName; StageOptions stageOptions = StageOptions.builder() .autoDeploy(false) .description("description") .domainMapping(DomainMappingOptions.builder() .domainName(domainName) // the properties below are optional .mappingKey("mappingKey") .build()) .throttle(ThrottleSettings.builder() .burstLimit(123) .rateLimit(123) .build()) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forStageOptions
static final class
An implementation forStageOptions
-
Method Summary
Modifier and TypeMethodDescriptionstatic StageOptions.Builder
builder()
default Boolean
Whether updates to an API automatically trigger a new deployment.default String
The description for the API stage.default DomainMappingOptions
The options for custom domain and api mapping.default ThrottleSettings
Throttle settings for the routes of this stage.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAutoDeploy
Whether updates to an API automatically trigger a new deployment.Default: false
-
getDescription
The description for the API stage.Default: - no description
-
getDomainMapping
The options for custom domain and api mapping.Default: - no custom domain and api mapping configuration
-
getThrottle
Throttle settings for the routes of this stage.Default: - no throttling configuration
-
builder
- Returns:
- a
StageOptions.Builder
ofStageOptions
-