Interface IHttpStageOptions

The options to create a new Stage for an HTTP API.

Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IHttpStageOptions : IStageOptions
Syntax (vb)
Public Interface IHttpStageOptions Inherits 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

Properties

StageName

The name of the stage.

Properties

StageName

The name of the stage.

string? StageName { get; }
Property Value

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.