# IHttpStage

Represents the HttpStage.

Extends: IHttpStage
Extends: IStage, IHttpStageRef
Implemented by: HttpStage

- Source: [`aws-apigatewayv2/lib/http/stage.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigatewayv2/lib/http/stage.ts#L35)
- Type last changed: v2.235.0 · 15 Jan 2026

## Properties

- `api`: [IHttpApi](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.IHttpApi.html) — The API this stage is associated to.

- `domainUrl`: string — The custom domain URL to this stage.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `isHttpStage`: boolean — Indicates that this is an HTTP Stage.

  Will always return true, but is necessary to prevent accidental structural
  equality in TypeScript.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

- `stageName`: string — The name of the stage;

  its primary identifier.

- `stageRef`: [StageReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_apigatewayv2.StageReference.html) — A reference to a Stage resource.

- `url`: string — The URL to this stage.

## Methods

- `addStageVariable(name: string, value: string): void` — Adds a stage variable to this stage.

  **Parameters**

  - `name` — The name of the stage variable.
  - `value` — The value of the stage variable.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — 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: string, props?: MetricOptions): Metric` — Return the given named metric for this HTTP Api Gateway Stage.

- `metricClientError(props?: MetricOptions): Metric` — Metric for the number of client-side errors captured in a given period.

- `metricCount(props?: MetricOptions): Metric` — Metric for the total number API requests in a given period.

- `metricDataProcessed(props?: MetricOptions): Metric` — Metric for the amount of data processed in bytes.

- `metricIntegrationLatency(props?: MetricOptions): 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?: MetricOptions): 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?: MetricOptions): Metric` — Metric for the number of server-side errors captured in a given period.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining