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.84.0 (build 5404dcf)",
date="2023-06-19T16:30:43.315Z")
@Stability(Experimental)
public interface StageOptions
extends software.amazon.jsii.JsiiSerializable
(experimental) 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) .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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forStageOptions
static final class
An implementation forStageOptions
-
Method Summary
Modifier and TypeMethodDescriptionstatic StageOptions.Builder
builder()
default Boolean
(experimental) Whether updates to an API automatically trigger a new deployment.default DomainMappingOptions
(experimental) The options for custom domain and api mapping.default ThrottleSettings
(experimental) Throttle settings for the routes of this stage.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAutoDeploy
(experimental) Whether updates to an API automatically trigger a new deployment.Default: false
-
getDomainMapping
(experimental) The options for custom domain and api mapping.Default: - no custom domain and api mapping configuration
-
getThrottle
(experimental) Throttle settings for the routes of this stage.Default: - no throttling configuration
-
builder
- Returns:
- a
StageOptions.Builder
ofStageOptions
-