class HttpStage (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Apigatewayv2.HttpStage`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#HttpStage`
Java	`software.amazon.awscdk.services.apigatewayv2.HttpStage`
Python	`aws_cdk.aws_apigatewayv2.HttpStage`
TypeScript (source)	`aws-cdk-lib` » `aws_apigatewayv2` » `HttpStage`

Implements IConstruct, IDependable, IResource, IHttpStage, IStage

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

Example

declare const api: apigwv2.HttpApi;

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

Initializer

new HttpStage(scope: Construct, id: string, props: HttpStageProps)

Parameters

scope Construct
id string
props HttpStageProps

Construct Props

Name	Type	Description
httpApi	`IHttpApi`	The HTTP API to which this stage is associated.
autoDeploy?	`boolean`	Whether updates to an API automatically trigger a new deployment.
description?	`string`	The description for the API stage.
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.

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.

description?

Type: string (optional, default: no description)

The description for the API stage.

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.

Properties

Name	Type	Description
api	`IHttpApi`	The API this stage is associated to.
baseApi	`IApi`
domainUrl	`string`	The custom domain URL to this stage.
env	`ResourceEnvironment`	The environment this resource belongs to.
node	`Node`	The tree node.
stack	`Stack`	The stack in which this resource is defined.
stageName	`string`	The name of the stage;
url	`string`	The URL to this stage.

api

Type: IHttpApi

The API this stage is associated to.

baseApi

Type: IApi

domainUrl

Type: string

The custom domain URL to this stage.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

Type: Node

The tree node.

stack

Type: Stack

The stack in which this resource is defined.

stageName

Type: string

The name of the stage;

its primary identifier.

url

Type: string

The URL to this stage.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
metric(metricName, props?)	Return the given named metric for this HTTP Api Gateway Stage.
metricClientError(props?)	Metric for the number of client-side errors captured in a given period.
metricCount(props?)	Metric for the total number API requests in a given period.
metricDataProcessed(props?)	Metric for the amount of data processed in bytes.
metricIntegrationLatency(props?)	Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
metricLatency(props?)	The time between when API Gateway receives a request from a client and when it returns a response to the client.
metricServerError(props?)	Metric for the number of server-side errors captured in a given period.
toString()	Returns a string representation of this construct.
static fromHttpStageAttributes(scope, id, attrs)	Import an existing stage into this CDK app.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

metricName string
props MetricOptions

Returns

Metric

Return the given named metric for this HTTP Api Gateway Stage.

metricClientError(props?)

public metricClientError(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

Metric for the number of client-side errors captured in a given period.

metricCount(props?)

public metricCount(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

Metric for the total number API requests in a given period.

metricDataProcessed(props?)

public metricDataProcessed(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

Metric for the amount of data processed in bytes.

metricIntegrationLatency(props?)

public metricIntegrationLatency(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

metricLatency(props?)

public metricLatency(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

metricServerError(props?)

public metricServerError(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

Metric for the number of server-side errors captured in a given period.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

static fromHttpStageAttributes(scope, id, attrs)

public static fromHttpStageAttributes(scope: Construct, id: string, attrs: HttpStageAttributes): IHttpStage

Parameters

scope Construct
id string
attrs HttpStageAttributes

Returns

IHttpStage

Import an existing stage into this CDK app.