java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.apigateway.StageBase
All Implemented Interfaces:
IResource, IStage, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
Stage

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:56.856Z") @Stability(Stable) public abstract class StageBase extends Resource implements IStage
Base class for an ApiGateway Stage.
  • Constructor Details

    • StageBase

      protected StageBase(software.amazon.jsii.JsiiObjectRef objRef)
    • StageBase

      protected StageBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • StageBase

      @Stability(Stable) protected StageBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -
    • StageBase

      @Stability(Stable) protected StageBase(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
  • Method Details

    • addApiKey

      @Stability(Stable) @NotNull public IApiKey addApiKey(@NotNull String id, @Nullable ApiKeyOptions options)
      Add an ApiKey to this stage.

      Specified by:
      addApiKey in interface IStage
      Parameters:
      id - This parameter is required.
      options -
    • addApiKey

      @Stability(Stable) @NotNull public IApiKey addApiKey(@NotNull String id)
      Add an ApiKey to this stage.

      Specified by:
      addApiKey in interface IStage
      Parameters:
      id - This parameter is required.
    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Returns the given named metric for this stage.

      Parameters:
      metricName - This parameter is required.
      props -
    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName)
      Returns the given named metric for this stage.

      Parameters:
      metricName - This parameter is required.
    • metricCacheHitCount

      @Stability(Stable) @NotNull public Metric metricCacheHitCount(@Nullable MetricOptions props)
      Metric for the number of requests served from the API cache in a given period.

      Default: - sum over 5 minutes

      Parameters:
      props -
    • metricCacheHitCount

      @Stability(Stable) @NotNull public Metric metricCacheHitCount()
      Metric for the number of requests served from the API cache in a given period.

      Default: - sum over 5 minutes

    • metricCacheMissCount

      @Stability(Stable) @NotNull public Metric metricCacheMissCount(@Nullable MetricOptions props)
      Metric for the number of requests served from the backend in a given period, when API caching is enabled.

      Default: - sum over 5 minutes

      Parameters:
      props -
    • metricCacheMissCount

      @Stability(Stable) @NotNull public Metric metricCacheMissCount()
      Metric for the number of requests served from the backend in a given period, when API caching is enabled.

      Default: - sum over 5 minutes

    • metricClientError

      @Stability(Stable) @NotNull public 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 public Metric metricClientError()
      Metric for the number of client-side errors captured in a given period.

      Default: - sum over 5 minutes

    • metricCount

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

      Default: - sample count over 5 minutes

      Parameters:
      props -
    • metricCount

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

      Default: - sample count over 5 minutes

    • metricIntegrationLatency

      @Stability(Stable) @NotNull public 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: - average over 5 minutes.

      Parameters:
      props -
    • metricIntegrationLatency

      @Stability(Stable) @NotNull public 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: - average over 5 minutes.

    • metricLatency

      @Stability(Stable) @NotNull public 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: - average over 5 minutes.

      Parameters:
      props -
    • metricLatency

      @Stability(Stable) @NotNull public 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: - average over 5 minutes.

    • metricServerError

      @Stability(Stable) @NotNull public 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 public Metric metricServerError()
      Metric for the number of server-side errors captured in a given period.

      Default: - sum over 5 minutes

    • urlForPath

      @Stability(Stable) @NotNull public String urlForPath(@Nullable String path)
      Returns the invoke URL for a certain path.

      Parameters:
      path - The resource path.
    • urlForPath

      @Stability(Stable) @NotNull public String urlForPath()
      Returns the invoke URL for a certain path.
    • getRestApi

      @Stability(Stable) @NotNull public abstract IRestApi getRestApi()
      RestApi to which this stage is associated.
      Specified by:
      getRestApi in interface IStage
    • getStageArn

      @Stability(Stable) @NotNull public String getStageArn()
      Returns the resource ARN for this stage:.

      arn:aws:apigateway:{region}::/restapis/{restApiId}/stages/{stageName}

      Note that this is separate from the execute-api ARN for methods and resources within this stage.

    • getStageName

      @Stability(Stable) @NotNull public abstract String getStageName()
      Name of this stage.
      Specified by:
      getStageName in interface IStage