@aws-cdk_aws-apigatewayv2-alpha.HttpStageProps

interface HttpStageProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.HttpStageProps
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#HttpStageProps
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.HttpStageProps
Pythonaws_cdk.aws_apigatewayv2_alpha.HttpStageProps
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป HttpStageProps

Properties to initialize an instance of HttpStage.

Example

declare const api: apigwv2.HttpApi;

new apigwv2.HttpStage(this, 'Stage', {
  httpApi: api,
  stageName: 'beta',
});

Properties

NameTypeDescription
httpApi๐Ÿ”นIHttpApiThe HTTP API to which this stage is associated.
autoDeploy?๐Ÿ”นbooleanWhether updates to an API automatically trigger a new deployment.
domainMapping?๐Ÿ”นDomainMappingOptionsThe options for custom domain and api mapping.
stageName?๐Ÿ”นstringThe name of the stage.
throttle?๐Ÿ”นThrottleSettingsThrottle settings for the routes of this stage.

httpApi๐Ÿ”น

Type: IHttpApi

The HTTP API to which this stage is associated.


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.