Interface CfnUsagePlan.ThrottleSettingsProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnUsagePlan.ThrottleSettingsProperty.Jsii$Proxy
- Enclosing class:
CfnUsagePlan
@Stability(Stable)
public static interface CfnUsagePlan.ThrottleSettingsProperty
extends software.amazon.jsii.JsiiSerializable
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigateway.*; ThrottleSettingsProperty throttleSettingsProperty = ThrottleSettingsProperty.builder() .burstLimit(123) .rateLimit(123) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnUsagePlan.ThrottleSettingsProperty
static final class
An implementation forCfnUsagePlan.ThrottleSettingsProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBurstLimit
The API target request burst rate limit.This allows more requests through for a period of time than the target rate limit.
- See Also:
-
getRateLimit
The API target request rate limit.- See Also:
-
builder
-