software.amazon.awscdk.services.apigatewayv2

Class HttpStage

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.HttpStage

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.503Z")
 @Stability(value=Experimental)
public class HttpStage
extends Resource
implements IStage

(experimental) Represents a stage where an instance of the API is deployed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpStage.Builder (experimental) A fluent builder for HttpStage.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IStage.Jsii$Default, IStage.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	HttpStage(software.constructs.Construct scope, String id, HttpStageProps props)
protected	HttpStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpStage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IStage	fromStageName(software.constructs.Construct scope, String id, String stageName) (experimental) Import an existing stage into this CDK app.
String	getStageName() (experimental) The name of the stage;
String	getUrl() (experimental) The URL to this stage.
Metric	metric(String metricName) (experimental) Return the given named metric for this HTTP Api Gateway Stage.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this HTTP Api Gateway Stage.
Metric	metricClientError() (experimental) Metric for the number of client-side errors captured in a given period.
Metric	metricClientError(MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.
Metric	metricCount() (experimental) Metric for the total number API requests in a given period.
Metric	metricCount(MetricOptions props) (experimental) Metric for the total number API requests in a given period.
Metric	metricDataProcessed() (experimental) Metric for the amount of data processed in bytes.
Metric	metricDataProcessed(MetricOptions props) (experimental) Metric for the amount of data processed in bytes.
Metric	metricIntegrationLatency() (experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Metric	metricIntegrationLatency(MetricOptions props) (experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Metric	metricLatency() (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric	metricLatency(MetricOptions props) (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric	metricServerError() (experimental) Metric for the number of server-side errors captured in a given period.
Metric	metricServerError(MetricOptions props) (experimental) Metric for the number of server-side errors captured in a given period.

Methods inherited from class software.amazon.awscdk.core.Resource

generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

HttpStage

protected HttpStage(software.amazon.jsii.JsiiObjectRef objRef)

HttpStage

protected HttpStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

HttpStage

@Stability(value=Experimental)
public HttpStage(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                HttpStageProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromStageName

@Stability(value=Experimental)
 @NotNull
public static IStage fromStageName(@NotNull
                                                                            software.constructs.Construct scope,
                                                                            @NotNull
                                                                            String id,
                                                                            @NotNull
                                                                            String stageName)

(experimental) Import an existing stage into this CDK app.

Parameters:

scope - This parameter is required.

id - This parameter is required.

stageName - This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName,
                                                              @Nullable
                                                              MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

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

Default: - average over 5 minutes

Parameters:

metricName - This parameter is required.

metricClientError

@Stability(value=Experimental)
 @NotNull
public Metric metricClientError(@Nullable
                                                                         MetricOptions props)

(experimental) Metric for the number of client-side errors captured in a given period.

Default: - sum over 5 minutes

Parameters:

props -

metricClientError

@Stability(value=Experimental)
 @NotNull
public Metric metricClientError()

(experimental) Metric for the number of client-side errors captured in a given period.

Default: - sum over 5 minutes

metricCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCount(@Nullable
                                                                   MetricOptions props)

(experimental) Metric for the total number API requests in a given period.

Default: - SampleCount over 5 minutes

Parameters:

props -

metricCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCount()

(experimental) Metric for the total number API requests in a given period.

Default: - SampleCount over 5 minutes

metricDataProcessed

@Stability(value=Experimental)
 @NotNull
public Metric metricDataProcessed(@Nullable
                                                                           MetricOptions props)

(experimental) Metric for the amount of data processed in bytes.

Default: - sum over 5 minutes

Parameters:

props -

metricDataProcessed

@Stability(value=Experimental)
 @NotNull
public Metric metricDataProcessed()

(experimental) Metric for the amount of data processed in bytes.

Default: - sum over 5 minutes

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricIntegrationLatency(@Nullable
                                                                                MetricOptions props)

(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Default: - no statistic

Parameters:

props -

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricIntegrationLatency()

(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Default: - no statistic

metricLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricLatency(@Nullable
                                                                     MetricOptions props)

(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Default: - no statistic

Parameters:

props -

metricLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricLatency()

(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Default: - no statistic

metricServerError

@Stability(value=Experimental)
 @NotNull
public Metric metricServerError(@Nullable
                                                                         MetricOptions props)

(experimental) Metric for the number of server-side errors captured in a given period.

Default: - sum over 5 minutes

Parameters:

props -

metricServerError

@Stability(value=Experimental)
 @NotNull
public Metric metricServerError()

(experimental) Metric for the number of server-side errors captured in a given period.

Default: - sum over 5 minutes

getStageName

@Stability(value=Experimental)
 @NotNull
public String getStageName()

(experimental) The name of the stage;

its primary identifier.

Specified by:

getStageName in interface IStage

getUrl

@Stability(value=Experimental)
 @NotNull
public String getUrl()

(experimental) The URL to this stage.