QuotaSettings

class aws_cdk.aws_apigateway.QuotaSettings(*, limit=None, offset=None, period=None)

Bases: object

Specifies the maximum number of requests that clients can make to API Gateway APIs.

Parameters
  • limit (Union[int, float, None]) – The maximum number of requests that users can make within the specified time period. Default: none

  • offset (Union[int, float, None]) – For the initial time period, the number of requests to subtract from the specified limit. Default: none

  • period (Optional[Period]) – The time period for which the maximum limit of requests applies. Default: none

Example:

# api is of type RestApi


key = apigateway.RateLimitedApiKey(self, "rate-limited-api-key",
    customer_id="hello-customer",
    resources=[api],
    quota=apigateway.QuotaSettings(
        limit=10000,
        period=apigateway.Period.MONTH
    )
)

Attributes

limit

The maximum number of requests that users can make within the specified time period.

Default

none

Return type

Union[int, float, None]

offset

For the initial time period, the number of requests to subtract from the specified limit.

Default

none

Return type

Union[int, float, None]

period

The time period for which the maximum limit of requests applies.

Default

none

Return type

Optional[Period]