Package software.amazon.awscdk.services.apigateway

Interface QuotaSettings

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

QuotaSettings.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:11.917Z")
@Stability(Stable)
public interface QuotaSettings
extends software.amazon.jsii.JsiiSerializable

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

Example:

 RestApi api;
 RateLimitedApiKey key = RateLimitedApiKey.Builder.create(this, "rate-limited-api-key")
         .customerId("hello-customer")
         .stages(List.of(api.getDeploymentStage()))
         .quota(QuotaSettings.builder()
                 .limit(10000)
                 .period(Period.MONTH)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static QuotaSettings.Builder	builder()
default Number	getLimit()	The maximum number of requests that users can make within the specified time period.
default Number	getOffset()	For the initial time period, the number of requests to subtract from the specified limit.
default Period	getPeriod()	The time period for which the maximum limit of requests applies.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLimit

@Stability(Stable)
@Nullable
default Number getLimit()

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

Default: none

getOffset

@Stability(Stable)
@Nullable
default Number getOffset()

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

Default: none

getPeriod

@Stability(Stable)
@Nullable
default Period getPeriod()

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

Default: none

builder

@Stability(Stable)
static QuotaSettings.Builder builder()

Returns:

a QuotaSettings.Builder of QuotaSettings