Interface IHttpStage
(experimental) Represents the HttpStage.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface IHttpStage : IStage, IResource, IConstruct, IDependable
Syntax (vb)
Public Interface IHttpStage
Inherits IStage, IResource, IConstruct, IConstruct, IDependable
Remarks
Stability: Experimental
Synopsis
Properties
Api | (experimental) The API this stage is associated to. |
DomainUrl | (experimental) The custom domain URL to this stage. |
Methods
MetricClientError(IMetricOptions) | (experimental) Metric for the number of client-side errors captured in a given period. |
MetricCount(IMetricOptions) | (experimental) Metric for the total number API requests in a given period. |
MetricDataProcessed(IMetricOptions) | (experimental) Metric for the amount of data processed in bytes. |
MetricIntegrationLatency(IMetricOptions) | (experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend. |
MetricLatency(IMetricOptions) | (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client. |
MetricServerError(IMetricOptions) | (experimental) Metric for the number of server-side errors captured in a given period. |
Properties
Api
(experimental) The API this stage is associated to.
IHttpApi Api { get; }
Property Value
Remarks
Stability: Experimental
DomainUrl
(experimental) The custom domain URL to this stage.
string DomainUrl { get; }
Property Value
System.String
Remarks
Stability: Experimental
Methods
MetricClientError(IMetricOptions)
(experimental) Metric for the number of client-side errors captured in a given period.
Metric MetricClientError(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricCount(IMetricOptions)
(experimental) Metric for the total number API requests in a given period.
Metric MetricCount(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: - SampleCount over 5 minutes
Stability: Experimental
MetricDataProcessed(IMetricOptions)
(experimental) Metric for the amount of data processed in bytes.
Metric MetricDataProcessed(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental
MetricIntegrationLatency(IMetricOptions)
(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(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: - no statistic
Stability: Experimental
MetricLatency(IMetricOptions)
(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric MetricLatency(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
The latency includes the integration latency and other API Gateway overhead.
Default: - no statistic
Stability: Experimental
MetricServerError(IMetricOptions)
(experimental) Metric for the number of server-side errors captured in a given period.
Metric MetricServerError(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Default: - sum over 5 minutes
Stability: Experimental