software.amazon.awscdk.services.apigatewayv2

Interface IApi

All Superinterfaces:

IConstruct, IDependable, IResource

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.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.259Z")
public interface IApi
extends IResource

(experimental) Represents a API Gateway HTTP/WebSocket API.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Method Detail

getApiEndpoint

java.lang.String getApiEndpoint()

(experimental) The default endpoint for an API.

getApiId

java.lang.String getApiId()

(experimental) The identifier of this API Gateway API.

metric

Metric metric(java.lang.String metricName,
              MetricOptions props)

(experimental) Return the given named metric for this Api Gateway.

Default: - average over 5 minutes

Parameters:

metricName - This parameter is required.

props -

metric

Metric metric(java.lang.String metricName)

(experimental) Return the given named metric for this Api Gateway.

Default: - average over 5 minutes

Parameters:

metricName - This parameter is required.