Package software.amazon.awscdk.services.apigatewayv2

Interface IStage

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IHttpStage, IHttpStage.Jsii$Default, IStage.Jsii$Default, IWebSocketStage, IWebSocketStage.Jsii$Default

All Known Implementing Classes:

HttpStage, IHttpStage.Jsii$Proxy, IStage.Jsii$Proxy, IWebSocketStage.Jsii$Proxy, WebSocketStage

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-10T01:10:04.343Z")
@Stability(Stable)
public interface IStage
extends software.amazon.jsii.JsiiSerializable, IResource

Represents a Stage.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
String	getStageName()	The name of the stage;
String	getUrl()	The URL to this stage.
Metric	metric(String metricName)	Return the given named metric for this HTTP Api Gateway Stage.
Metric	metric(String metricName, MetricOptions props)	Return the given named metric for this HTTP Api Gateway Stage.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStageName

@Stability(Stable)
@NotNull
String getStageName()

The name of the stage;

its primary identifier.

getUrl

@Stability(Stable)
@NotNull
String getUrl()

The URL to this stage.

metric

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

Return the given named metric for this HTTP Api Gateway Stage.

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 HTTP Api Gateway Stage.

Default: - average over 5 minutes

Parameters:

metricName - This parameter is required.