Package software.amazon.awscdk.services.apigatewayv2

Interface IHttpStage

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IHttpStageRef, IResource, IStage, IStageRef, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IHttpStage.Jsii$Default
All Known Implementing Classes:
HttpStage, IHttpStage.Jsii$Proxy
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-15T15:34:50.131Z") @Stability(Stable) public interface IHttpStage extends software.amazon.jsii.JsiiSerializable, IStage, IHttpStageRef
Represents the HttpStage.

  • Method Details

    • getApi

      @Stability(Stable) @NotNull IHttpApi getApi()
      The API this stage is associated to.

    • getDomainUrl

      @Stability(Stable) @NotNull String getDomainUrl()
      The custom domain URL to this stage.

    • metricClientError

      @Stability(Stable) @NotNull Metric metricClientError(@Nullable MetricOptions props)
      Metric for the number of client-side errors captured in a given period.

      Default: - sum over 5 minutes

      Parameters:
      props -

    • metricClientError

      @Stability(Stable) @NotNull Metric metricClientError()
      Metric for the number of client-side errors captured in a given period.

      Default: - sum over 5 minutes

    • metricCount

      @Stability(Stable) @NotNull Metric metricCount(@Nullable MetricOptions props)
      Metric for the total number API requests in a given period.

      Default: - SampleCount over 5 minutes

      Parameters:
      props -

    • metricCount

      @Stability(Stable) @NotNull Metric metricCount()
      Metric for the total number API requests in a given period.

      Default: - SampleCount over 5 minutes

    • metricDataProcessed

      @Stability(Stable) @NotNull Metric metricDataProcessed(@Nullable MetricOptions props)
      Metric for the amount of data processed in bytes.

      Default: - sum over 5 minutes

      Parameters:
      props -

    • metricDataProcessed

      @Stability(Stable) @NotNull Metric metricDataProcessed()
      Metric for the amount of data processed in bytes.

      Default: - sum over 5 minutes

    • metricIntegrationLatency

      @Stability(Stable) @NotNull Metric metricIntegrationLatency(@Nullable MetricOptions props)
      Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

      Default: - no statistic

      Parameters:
      props -

    • metricIntegrationLatency

      @Stability(Stable) @NotNull Metric metricIntegrationLatency()
      Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

      Default: - no statistic

    • metricLatency

      @Stability(Stable) @NotNull Metric metricLatency(@Nullable MetricOptions props)
      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.

      Default: - no statistic

      Parameters:
      props -

    • metricLatency

      @Stability(Stable) @NotNull Metric metricLatency()
      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.

      Default: - no statistic

    • metricServerError

      @Stability(Stable) @NotNull Metric metricServerError(@Nullable MetricOptions props)
      Metric for the number of server-side errors captured in a given period.

      Default: - sum over 5 minutes

      Parameters:
      props -

    • metricServerError

      @Stability(Stable) @NotNull Metric metricServerError()
      Metric for the number of server-side errors captured in a given period.

      Default: - sum over 5 minutes