interface HttpStageOptions 🔹

Language	Type name
.NET	Amazon.CDK.AWS.APIGatewayv2.HttpStageOptions
Java	software.amazon.awscdk.services.apigatewayv2.HttpStageOptions
Python	aws_cdk.aws_apigatewayv2.HttpStageOptions
TypeScript (source)	@aws-cdk/aws-apigatewayv2 » HttpStageOptions

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

Example

declare const api: apigwv2.HttpApi;
declare const dn: apigwv2.DomainName;

api.addStage('beta', {
  stageName: 'beta',
  autoDeploy: true,
  // https://${dn.domainName}/bar goes to the beta stage
  domainMapping: {
    domainName: dn,
    mappingKey: 'bar',
  },
});

Properties

Name	Type	Description
autoDeploy?🔹	boolean	Whether updates to an API automatically trigger a new deployment.
domainMapping?🔹	DomainMappingOptions	The options for custom domain and api mapping.
stageName?🔹	string	The name of the stage.
throttle?🔹	ThrottleSettings	Throttle settings for the routes of this stage.

---

autoDeploy?🔹

Type: boolean (optional, default: false)

Whether updates to an API automatically trigger a new deployment.

---

domainMapping?🔹

Type: DomainMappingOptions (optional, default: no custom domain and api mapping configuration)

The options for custom domain and api mapping.

---

stageName?🔹

Type: string (optional, default: '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.)

The name of the stage.

See StageName class for more details.

---

throttle?🔹

Type: ThrottleSettings (optional, default: no throttling configuration)

Throttle settings for the routes of this stage.