Interface IQuotaSettings
Specifies the maximum number of requests that clients can make to API Gateway APIs.
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IQuotaSettings
Syntax (vb)
Public Interface IQuotaSettings
Remarks
ExampleMetadata: infused
Examples
RestApi api;
var key = new RateLimitedApiKey(this, "rate-limited-api-key", new RateLimitedApiKeyProps {
CustomerId = "hello-customer",
Stages = new [] { api.DeploymentStage },
Quota = new QuotaSettings {
Limit = 10000,
Period = Period.MONTH
}
});
Synopsis
Properties
Limit | The maximum number of requests that users can make within the specified time period. |
Offset | For the initial time period, the number of requests to subtract from the specified limit. |
Period | The time period for which the maximum limit of requests applies. |
Properties
Limit
The maximum number of requests that users can make within the specified time period.
virtual Nullable<double> Limit { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: none
Offset
For the initial time period, the number of requests to subtract from the specified limit.
virtual Nullable<double> Offset { get; }
Property Value
System.Nullable<System.Double>
Remarks
Default: none
Period
The time period for which the maximum limit of requests applies.
virtual Nullable<Period> Period { get; }
Property Value
System.Nullable<Period>
Remarks
Default: none