software.amazon.awscdk.services.apigatewayv2

Interface IApi

All Superinterfaces:

software.constructs.IConstruct, IDependable, 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.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.848Z")
 @Stability(value=Experimental)
public interface IApi
extends software.amazon.jsii.JsiiSerializable, 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
String	getApiEndpoint() (experimental) The default endpoint for an API.
String	getApiId() (experimental) The identifier of this API Gateway API.
Metric	metric(String metricName) (experimental) Return the given named metric for this Api Gateway.
Metric	metric(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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiEndpoint

@Stability(value=Experimental)
 @NotNull
String getApiEndpoint()

(experimental) The default endpoint for an API.

getApiId

@Stability(value=Experimental)
 @NotNull
String getApiId()

(experimental) The identifier of this API Gateway API.

metric

@Stability(value=Experimental)
 @NotNull
Metric metric(@NotNull
                                                       String metricName,
                                                       @Nullable
                                                       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

@Stability(value=Experimental)
 @NotNull
Metric metric(@NotNull
                                                       String metricName)

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

Default: - average over 5 minutes

Parameters:

metricName - This parameter is required.