Package software.amazon.awscdk.services.apigatewayv2

Interface ThrottleSettings

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ThrottleSettings.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.316Z") @Stability(Experimental) public interface ThrottleSettings extends software.amazon.jsii.JsiiSerializable
(experimental) Container for defining throttling parameters to API stages.

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.apigatewayv2.*;
 ThrottleSettings throttleSettings = ThrottleSettings.builder()
         .burstLimit(123)
         .rateLimit(123)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    ThrottleSettings.Builder
    A builder for ThrottleSettings
    static final class 
    ThrottleSettings.Jsii$Proxy
    An implementation for ThrottleSettings

  • Method Summary

    Modifier and Type
    Method
    Description
    static ThrottleSettings.Builder
    builder()
     
    default Number
    getBurstLimit()
    (experimental) The maximum API request rate limit over a time ranging from one to a few seconds.
    default Number
    getRateLimit()
    (experimental) The API request steady-state rate limit (average requests per second over an extended period of time).

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getBurstLimit

      @Stability(Experimental) @Nullable default Number getBurstLimit()
      (experimental) The maximum API request rate limit over a time ranging from one to a few seconds.

      Default: none

    • getRateLimit

      @Stability(Experimental) @Nullable default Number getRateLimit()
      (experimental) The API request steady-state rate limit (average requests per second over an extended period of time).

      Default: none

    • builder

      @Stability(Experimental) static ThrottleSettings.Builder builder()
      Returns:
      a ThrottleSettings.Builder of ThrottleSettings