Interface IApi
(experimental) Represents a API Gateway HTTP/WebSocket API.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface IApi : IResource, IConstruct, IDependable
Syntax (vb)
Public Interface IApi
Inherits IResource, IConstruct, IConstruct, IDependable
Remarks
Stability: Experimental
Synopsis
Properties
ApiEndpoint | (experimental) The default endpoint for an API. |
ApiId | (experimental) The identifier of this API Gateway API. |
Methods
Metric(String, IMetricOptions) | (experimental) Return the given named metric for this Api Gateway. |
Properties
ApiEndpoint
(experimental) The default endpoint for an API.
string ApiEndpoint { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
ApiId
(experimental) The identifier of this API Gateway API.
string ApiId { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
Methods
Metric(String, IMetricOptions)
(experimental) Return the given named metric for this Api Gateway.
Metric Metric(string metricName, IMetricOptions props = null)
Parameters
- metricName System.String
- props IMetricOptions
Returns
Remarks
Default: - average over 5 minutes
Stability: Experimental