Class StageOptions
(experimental) Options required to create a new stage.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class StageOptions : Object, IStageOptions
Syntax (vb)
Public Class StageOptions
Inherits Object
Implements IStageOptions
Remarks
Options that are common between HTTP and Websocket APIs.
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
DomainName domainName;
var stageOptions = new StageOptions {
AutoDeploy = false,
DomainMapping = new DomainMappingOptions {
DomainName = domainName,
// the properties below are optional
MappingKey = "mappingKey"
},
Throttle = new ThrottleSettings {
BurstLimit = 123,
RateLimit = 123
}
};
Synopsis
Constructors
StageOptions() |
Properties
AutoDeploy | (experimental) Whether updates to an API automatically trigger a new deployment. |
DomainMapping | (experimental) The options for custom domain and api mapping. |
Throttle | (experimental) Throttle settings for the routes of this stage. |
Constructors
StageOptions()
public StageOptions()
Properties
AutoDeploy
(experimental) Whether updates to an API automatically trigger a new deployment.
public Nullable<bool> AutoDeploy { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
DomainMapping
(experimental) The options for custom domain and api mapping.
public IDomainMappingOptions DomainMapping { get; set; }
Property Value
Remarks
Default: - no custom domain and api mapping configuration
Stability: Experimental
Throttle
(experimental) Throttle settings for the routes of this stage.
public IThrottleSettings Throttle { get; set; }
Property Value
Remarks
Default: - no throttling configuration
Stability: Experimental