Class HttpStageProps
Properties to initialize an instance of HttpStage
.
Inheritance
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HttpStageProps : Object, IHttpStageProps, IHttpStageOptions, IStageOptions
Syntax (vb)
Public Class HttpStageProps
Inherits Object
Implements IHttpStageProps, IHttpStageOptions, IStageOptions
Remarks
ExampleMetadata: infused
Examples
HttpApi api;
new HttpStage(this, "Stage", new HttpStageProps {
HttpApi = api,
StageName = "beta"
});
Synopsis
Constructors
HttpStageProps() |
Properties
AutoDeploy | Whether updates to an API automatically trigger a new deployment. |
DomainMapping | The options for custom domain and api mapping. |
HttpApi | The HTTP API to which this stage is associated. |
StageName | The name of the stage. |
Throttle | Throttle settings for the routes of this stage. |
Constructors
HttpStageProps()
public HttpStageProps()
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
HttpApi
The HTTP API to which this stage is associated.
public IHttpApi HttpApi { get; set; }
Property Value
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