Interface IHttpStage

Represents the HttpStage.

Inherited Members

IStage.Metric(string, IMetricOptions)

IStage.StageName

IStage.Url

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Env

IResource.Stack

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IHttpStage : IStage, IResource, IConstruct, IDependable

Syntax (vb)

Public Interface IHttpStage Inherits IStage, IResource, IConstruct, IDependable

Synopsis

Properties

Api	The API this stage is associated to.
DomainUrl	The custom domain URL to this stage.

Methods

MetricClientError(IMetricOptions?)	Metric for the number of client-side errors captured in a given period.
MetricCount(IMetricOptions?)	Metric for the total number API requests in a given period.
MetricDataProcessed(IMetricOptions?)	Metric for the amount of data processed in bytes.
MetricIntegrationLatency(IMetricOptions?)	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?)	The time between when API Gateway receives a request from a client and when it returns a response to the client.
MetricServerError(IMetricOptions?)	Metric for the number of server-side errors captured in a given period.

Properties

Api

The API this stage is associated to.

IHttpApi Api { get; }

Property Value

IHttpApi

DomainUrl

The custom domain URL to this stage.

string DomainUrl { get; }

Property Value

string

Methods

MetricClientError(IMetricOptions?)

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

Metric MetricClientError(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricCount(IMetricOptions?)

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

Metric MetricCount(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - SampleCount over 5 minutes

MetricDataProcessed(IMetricOptions?)

Metric for the amount of data processed in bytes.

Metric MetricDataProcessed(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes

MetricIntegrationLatency(IMetricOptions?)

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

Metric

Remarks

Default: - no statistic

MetricLatency(IMetricOptions?)

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

Metric

Remarks

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

Default: - no statistic

MetricServerError(IMetricOptions?)

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

Metric MetricServerError(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Default: - sum over 5 minutes