Class HttpStageOptions
The options to create a new Stage for an HTTP API.
Inheritance
System.Object
HttpStageOptions
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HttpStageOptions : Object, IHttpStageOptions, IStageOptions
Syntax (vb)
Public Class HttpStageOptions
Inherits Object
Implements IHttpStageOptions, IStageOptions
Remarks
ExampleMetadata: infused
Examples
HttpApi api;
DomainName dn;
api.AddStage("beta", new HttpStageOptions {
StageName = "beta",
AutoDeploy = true,
// https://${dn.domainName}/bar goes to the beta stage
DomainMapping = new DomainMappingOptions {
DomainName = dn,
MappingKey = "bar"
}
});
Synopsis
Constructors
HttpStageOptions() |
Properties
AutoDeploy | Whether updates to an API automatically trigger a new deployment. |
DomainMapping | The options for custom domain and api mapping. |
StageName | The name of the stage. |
Throttle | Throttle settings for the routes of this stage. |
Constructors
HttpStageOptions()
public HttpStageOptions()
Properties
AutoDeploy
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
DomainMapping
The options for custom domain and api mapping.
public IDomainMappingOptions DomainMapping { get; set; }
Property Value
Remarks
Default: - no custom domain and api mapping configuration
StageName
The name of the stage.
public string StageName { get; set; }
Property Value
System.String
Remarks
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.
Throttle
Throttle settings for the routes of this stage.
public IThrottleSettings Throttle { get; set; }
Property Value
Remarks
Default: - no throttling configuration