ThrottleSettings

class aws_cdk.aws_apigatewayv2.ThrottleSettings(*, burst_limit=None, rate_limit=None)

Bases: object

(experimental) Container for defining throttling parameters to API stages.

Parameters:

• burst_limit (Union[int, float, None]) – (experimental) The maximum API request rate limit over a time ranging from one to a few seconds. Default: none

• rate_limit (Union[int, float, None]) – (experimental) The API request steady-state rate limit (average requests per second over an extended period of time). Default: none

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

throttle_settings = apigatewayv2.ThrottleSettings(
    burst_limit=123,
    rate_limit=123
)

Attributes

burst_limit

(experimental) The maximum API request rate limit over a time ranging from one to a few seconds.

Default:

none

Stability:

experimental

rate_limit

(experimental) The API request steady-state rate limit (average requests per second over an extended period of time).

Default:

none

Stability:

experimental