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.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.868Z")
 @Stability(value=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 and Description
static class	ThrottleSettings.Builder A builder for ThrottleSettings
static class	ThrottleSettings.Jsii$Proxy An implementation for ThrottleSettings

Method Summary

Modifier and Type	Method and 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 Detail

getBurstLimit

@Stability(value=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(value=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(value=Experimental)
static ThrottleSettings.Builder builder()

Returns:

a ThrottleSettings.Builder of ThrottleSettings