Interface CfnUsagePlan.IThrottleSettingsProperty
ThrottleSettings
is a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public interface IThrottleSettingsProperty
Syntax (vb)
Public Interface IThrottleSettingsProperty
Remarks
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.APIGateway;
var throttleSettingsProperty = new ThrottleSettingsProperty {
BurstLimit = 123,
RateLimit = 123
};
Synopsis
Properties
BurstLimit | The API target request burst rate limit. |
RateLimit | The API target request rate limit. |
Properties
BurstLimit
The API target request burst rate limit.
virtual Nullable<double> BurstLimit { get; }
Property Value
System.Nullable<System.Double>
Remarks
This allows more requests through for a period of time than the target rate limit.
RateLimit
The API target request rate limit.
virtual Nullable<double> RateLimit { get; }
Property Value
System.Nullable<System.Double>