@aws-cdk_aws-apigatewayv2-alpha.HttpStageOptions

interface HttpStageOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.HttpStageOptions
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#HttpStageOptions
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.HttpStageOptions
Pythonaws_cdk.aws_apigatewayv2_alpha.HttpStageOptions
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป 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

NameTypeDescription
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.

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.