Interface IApi

Represents a API Gateway HTTP/WebSocket API.

Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IApi : IResource, IConstruct, IDependable
Syntax (vb)
Public Interface IApi Inherits IResource, IConstruct, IDependable

Synopsis

Properties

ApiEndpoint

The default endpoint for an API.
ApiId

The identifier of this API Gateway API.

Methods

Metric(string, IMetricOptions?)

Return the given named metric for this Api Gateway.

Properties

ApiEndpoint

The default endpoint for an API.

string ApiEndpoint { get; }
Property Value

string

Remarks

Attribute: true

ApiId

The identifier of this API Gateway API.

string ApiId { get; }
Property Value

string

Remarks

Attribute: true

Methods

Metric(string, IMetricOptions?)

Return the given named metric for this Api Gateway.

Metric Metric(string metricName, IMetricOptions? props = null)
Parameters
metricName string
props IMetricOptions
Returns

Metric

Remarks

Default: - average over 5 minutes