Package software.amazon.awscdk.services.apigatewayv2

Interface IApi.Jsii$Default

All Superinterfaces:

IApi, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IHttpApi.Jsii$Default, IWebSocketApi.Jsii$Default

All Known Implementing Classes:

IApi.Jsii$Proxy, IHttpApi.Jsii$Proxy, IWebSocketApi.Jsii$Proxy

Enclosing interface:

IApi

@Internal
public static interface IApi.Jsii$Default
extends IApi, IResource.Jsii$Default

Internal default implementation for IApi.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IApi

IApi.Jsii$Default, IApi.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.constructs.IConstruct.Jsii$Default

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware.Jsii$Default

getEnv

Methods inherited from interface software.amazon.awscdk.IResource.Jsii$Default

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiEndpoint

@Stability(Stable)
@NotNull
default String getApiEndpoint()

The default endpoint for an API.

Specified by:

getApiEndpoint in interface IApi

getApiId

@Stability(Stable)
@NotNull
default String getApiId()

The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

metric

@Stability(Stable)
@NotNull
default Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

Return the given named metric for this Api Gateway.

Default: - average over 5 minutes

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Stable)
@NotNull
default Metric metric(@NotNull
 String metricName)

Return the given named metric for this Api Gateway.

Default: - average over 5 minutes

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.