AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

HttpStage

Represents a stage where an instance of the API is deployed.

Import

import { HttpStage } from 'aws-cdk-lib/aws-apigatewayv2';

Or use the module namespace:

import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
// apigatewayv2.HttpStage

Properties

Configuration passed to the constructor as HttpStageProps.

httpApiRequired
IHttpApiRef

The HTTP API to which this stage is associated.

1 property inherited from HttpStageOptions
stageNameOptionalinherited from HttpStageOptions
string

The name of the stage. 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.

7 properties inherited from StageOptions
accessLogSettingsOptionalinherited from StageOptions
IAccessLogSettings

Settings for access logging.

Default: - No access logging

autoDeployOptionalinherited from StageOptions
boolean

Whether updates to an API automatically trigger a new deployment.

Default: false

descriptionOptionalinherited from StageOptions
string

The description for the API stage.

Default: - no description

detailedMetricsEnabledOptionalinherited from StageOptions
boolean

Specifies whether detailed metrics are enabled.

Default: false

domainMappingOptionalinherited from StageOptions
DomainMappingOptions

The options for custom domain and api mapping.

Default: - no custom domain and api mapping configuration

stageVariablesOptionalinherited from StageOptions
{ [key: string]: string }

Stage variables for the stage. These are key-value pairs that you can define and use in your API routes. The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables

Default: - No stage variables

throttleOptionalinherited from StageOptions
ThrottleSettings

Throttle settings for the routes of this stage.

Default: - no throttling configuration

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL2 (Higher-level)
Moduleaws-apigatewayv2
Properties9

Related Constructs

Explore This Service

External Links