Package software.amazon.awscdk.services.apigatewayv2

Interface IApi

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IApi.Jsii$Default, IHttpApi, IHttpApi.Jsii$Default, IWebSocketApi, IWebSocketApi.Jsii$Default
All Known Implementing Classes:
HttpApi, IApi.Jsii$Proxy, IHttpApi.Jsii$Proxy, IWebSocketApi.Jsii$Proxy, WebSocketApi
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:57.577Z") @Stability(Stable) public interface IApi extends software.amazon.jsii.JsiiSerializable, IResource
Represents a API Gateway HTTP/WebSocket API.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IApi.Jsii$Default
    Internal default implementation for IApi.
    static final class 
    IApi.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApiEndpoint()
    The default endpoint for an API.
    String
    getApiId()
    The identifier of this API Gateway API.
    Metric
    metric(String metricName)
    Return the given named metric for this Api Gateway.
    Metric
    metric(String metricName, MetricOptions props)
    Return the given named metric for this Api Gateway.

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

    getEnv

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getApiEndpoint

      @Stability(Stable) @NotNull String getApiEndpoint()
      The default endpoint for an API.

    • getApiId

      @Stability(Stable) @NotNull String getApiId()
      The identifier of this API Gateway API.

    • metric

      @Stability(Stable) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this Api Gateway.

      Default: - average over 5 minutes

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Default: - average over 5 minutes

      Parameters:
      metricName - This parameter is required.