@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:56.709Z") public class HttpStage extends Resource implements IHttpStage, IStage
Example:
HttpApi api; HttpStage.Builder.create(this, "Stage") .httpApi(api) .stageName("beta") .build();
Modifier and Type | Class and Description |
---|---|
static class |
HttpStage.Builder
(experimental) A fluent builder for
HttpStage . |
IHttpStage.Jsii$Default, IHttpStage.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
HttpStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
HttpStage(software.amazon.jsii.JsiiObjectRef objRef) |
|
HttpStage(software.constructs.Construct scope,
java.lang.String id,
HttpStageProps props) |
Modifier and Type | Method and Description |
---|---|
static IHttpStage |
fromHttpStageAttributes(software.constructs.Construct scope,
java.lang.String id,
HttpStageAttributes attrs)
(experimental) Import an existing stage into this CDK app.
|
IHttpApi |
getApi()
(experimental) The API this stage is associated to.
|
protected IApi |
getBaseApi() |
java.lang.String |
getDomainUrl()
(experimental) The custom domain URL to this stage.
|
java.lang.String |
getStageName()
(experimental) The name of the stage;
|
java.lang.String |
getUrl()
(experimental) The URL to this stage.
|
Metric |
metric(java.lang.String metricName)
(experimental) Return the given named metric for this HTTP Api Gateway Stage.
|
Metric |
metric(java.lang.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.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected HttpStage(software.amazon.jsii.JsiiObjectRef objRef)
protected HttpStage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public HttpStage(software.constructs.Construct scope, java.lang.String id, HttpStageProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public static IHttpStage fromHttpStageAttributes(software.constructs.Construct scope, java.lang.String id, HttpStageAttributes attrs)
scope
- This parameter is required.id
- This parameter is required.attrs
- This parameter is required.public Metric metric(java.lang.String metricName, MetricOptions props)
public Metric metric(java.lang.String metricName)
public Metric metricClientError(MetricOptions props)
metricClientError
in interface IHttpStage
props
- public Metric metricClientError()
metricClientError
in interface IHttpStage
public Metric metricCount(MetricOptions props)
metricCount
in interface IHttpStage
props
- public Metric metricCount()
metricCount
in interface IHttpStage
public Metric metricDataProcessed(MetricOptions props)
metricDataProcessed
in interface IHttpStage
props
- public Metric metricDataProcessed()
metricDataProcessed
in interface IHttpStage
public Metric metricIntegrationLatency(MetricOptions props)
metricIntegrationLatency
in interface IHttpStage
props
- public Metric metricIntegrationLatency()
metricIntegrationLatency
in interface IHttpStage
public Metric metricLatency(MetricOptions props)
The latency includes the integration latency and other API Gateway overhead.
metricLatency
in interface IHttpStage
props
- public Metric metricLatency()
The latency includes the integration latency and other API Gateway overhead.
metricLatency
in interface IHttpStage
public Metric metricServerError(MetricOptions props)
metricServerError
in interface IHttpStage
props
- public Metric metricServerError()
metricServerError
in interface IHttpStage
public IHttpApi getApi()
getApi
in interface IHttpStage
protected IApi getBaseApi()
public java.lang.String getDomainUrl()
getDomainUrl
in interface IHttpStage
public java.lang.String getStageName()
its primary identifier.
getStageName
in interface IStage