Package software.amazon.awscdk.services.apigatewayv2

Interface IHttpStage.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IHttpStage, IHttpStageRef, IHttpStageRef.Jsii$Default, IResource, IResource.Jsii$Default, IStage, IStage.Jsii$Default, IStageRef, IStageRef.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IHttpStage.Jsii$Proxy
Enclosing interface:
IHttpStage
@Internal public static interface IHttpStage.Jsii$Default extends IHttpStage, IHttpStageRef.Jsii$Default, IStage.Jsii$Default
Internal default implementation for IHttpStage.

  • Method Details

    • getApi

      @Stability(Stable) @NotNull default IHttpApi getApi()
      The API this stage is associated to.
      Specified by:
      getApi in interface IHttpStage

    • getDomainUrl

      @Stability(Stable) @NotNull default String getDomainUrl()
      The custom domain URL to this stage.
      Specified by:
      getDomainUrl in interface IHttpStage

    • metric

      @Stability(Stable) @NotNull default Metric metric(@NotNull String metricName)
      Return the given named metric for this HTTP Api Gateway Stage.

      Default: - average over 5 minutes

      Specified by:
      metric in interface IStage
      Specified by:
      metric in interface IStage.Jsii$Default
      Parameters:
      metricName - This parameter is required.

    • metricClientError

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

      Default: - sum over 5 minutes

      Specified by:
      metricClientError in interface IHttpStage
      Parameters:
      props -

    • metricClientError

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

      Default: - sum over 5 minutes

      Specified by:
      metricClientError in interface IHttpStage

    • metricCount

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

      Default: - SampleCount over 5 minutes

      Specified by:
      metricCount in interface IHttpStage
      Parameters:
      props -

    • metricCount

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

      Default: - SampleCount over 5 minutes

      Specified by:
      metricCount in interface IHttpStage

    • metricDataProcessed

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

      Default: - sum over 5 minutes

      Specified by:
      metricDataProcessed in interface IHttpStage
      Parameters:
      props -

    • metricDataProcessed

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

      Default: - sum over 5 minutes

      Specified by:
      metricDataProcessed in interface IHttpStage

    • metricIntegrationLatency

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricIntegrationLatency in interface IHttpStage
      Parameters:
      props -

    • metricIntegrationLatency

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricIntegrationLatency in interface IHttpStage

    • metricLatency

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricLatency in interface IHttpStage
      Parameters:
      props -

    • metricLatency

      @Stability(Stable) @NotNull default 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

      Specified by:
      metricLatency in interface IHttpStage

    • metricServerError

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

      Default: - sum over 5 minutes

      Specified by:
      metricServerError in interface IHttpStage
      Parameters:
      props -

    • metricServerError

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

      Default: - sum over 5 minutes

      Specified by:
      metricServerError in interface IHttpStage