ThrottleSettings

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

Bases: object

Container for defining throttling parameters to API stages.

Parameters:

burst_limit (Union[int, float, None]) – The maximum API request rate limit over a time ranging from one to a few seconds. Default: none
rate_limit (Union[int, float, None]) – The API request steady-state rate limit (average requests per second over an extended period of time). Default: none

ExampleMetadata:

infused

Example:

api_key = apigwv2.ApiKey(self, "ApiKey")

usage_plan = apigwv2.UsagePlan(self, "UsagePlan",
    usage_plan_name="WebSocketUsagePlan",
    throttle=apigwv2.ThrottleSettings(
        rate_limit=10,
        burst_limit=2
    )
)

usage_plan.add_api_key(api_key)

Attributes

burst_limit

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

Default:: none

rate_limit

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

Default:: none