interface HttpStageOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.HttpStageOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#HttpStageOptions |
![]() | software.amazon.awscdk.services.apigatewayv2.HttpStageOptions |
![]() | aws_cdk.aws_apigatewayv2.HttpStageOptions |
![]() | aws-cdk-lib » 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 |
---|---|---|
auto | boolean | Whether updates to an API automatically trigger a new deployment. |
description? | string | The description for the API stage. |
detailed | boolean | Specifies whether detailed metrics are enabled. |
domain | Domain | The options for custom domain and api mapping. |
stage | string | The name of the stage. |
throttle? | Throttle | Throttle settings for the routes of this stage. |
autoDeploy?
Type:
boolean
(optional, default: false)
Whether updates to an API automatically trigger a new deployment.
description?
Type:
string
(optional, default: no description)
The description for the API stage.
detailedMetricsEnabled?
Type:
boolean
(optional, default: false)
Specifies whether detailed metrics are enabled.
domainMapping?
Type:
Domain
(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:
Throttle
(optional, default: no throttling configuration)
Throttle settings for the routes of this stage.