Class ThrottleSettings
(experimental) Container for defining throttling parameters to API stages.
Inheritance
System.Object
ThrottleSettings
Implements
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class ThrottleSettings : Object, IThrottleSettings
Syntax (vb)
Public Class ThrottleSettings
Inherits Object
Implements IThrottleSettings
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
var throttleSettings = new ThrottleSettings {
BurstLimit = 123,
RateLimit = 123
};
Synopsis
Constructors
ThrottleSettings() |
Properties
BurstLimit | (experimental) The maximum API request rate limit over a time ranging from one to a few seconds. |
RateLimit | (experimental) The API request steady-state rate limit (average requests per second over an extended period of time). |
Constructors
ThrottleSettings()
public ThrottleSettings()
Properties
BurstLimit
(experimental) The maximum API request rate limit over a time ranging from one to a few seconds.
public Nullable<double> BurstLimit { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: none
Stability: Experimental
RateLimit
(experimental) The API request steady-state rate limit (average requests per second over an extended period of time).
public Nullable<double> RateLimit { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: none
Stability: Experimental