Package software.amazon.awscdk.services.apigatewayv2

Interface IStage.Jsii$Default

All Superinterfaces:

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

All Known Subinterfaces:

IHttpStage.Jsii$Default, IWebSocketStage.Jsii$Default

All Known Implementing Classes:

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

Enclosing interface:

IStage

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

Internal default implementation for IStage.

Nested Class Summary

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

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

IStage.Jsii$Default, IStage.Jsii$Proxy

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

IStageRef.Jsii$Default, IStageRef.Jsii$Proxy

Method Summary

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

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.awscdk.interfaces.apigatewayv2.IStageRef.Jsii$Default

getStageRef

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStageName

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

The name of the stage;

its primary identifier.

Specified by:

getStageName in interface IStage

getUrl

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

The URL to this stage.

Specified by:

getUrl in interface IStage

addStageVariable

@Stability(Stable)
default void addStageVariable(@NotNull
 String name,
 @NotNull
 String value)

Adds a stage variable to this stage.

Specified by:

addStageVariable in interface IStage

Parameters:

name - The name of the stage variable. This parameter is required.

value - The value of the stage variable. This parameter is required.

metric

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

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

Default: - average over 5 minutes

Specified by:

metric in interface IStage

Parameters:

metricName - This parameter is required.

props -

metric

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

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

Default: - average over 5 minutes

Specified by:

metric in interface IStage

Parameters:

metricName - This parameter is required.