Class QuotaSettings

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

Inheritance

object

QuotaSettings

Implements

IQuotaSettings

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class QuotaSettings : IQuotaSettings

Syntax (vb)

Public Class QuotaSettings Implements IQuotaSettings

Remarks

ExampleMetadata: infused

Examples

RestApi api;


            var key = new RateLimitedApiKey(this, "rate-limited-api-key", new RateLimitedApiKeyProps {
                CustomerId = "hello-customer",
                ApiStages = new [] { new UsagePlanPerApiStage { Stage = api.DeploymentStage } },
                Quota = new QuotaSettings {
                    Limit = 10000,
                    Period = Period.MONTH
                }
            });

Synopsis

Constructors

QuotaSettings()

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

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.

Constructors

QuotaSettings()

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

public QuotaSettings()

Remarks

ExampleMetadata: infused

Examples

RestApi api;


            var key = new RateLimitedApiKey(this, "rate-limited-api-key", new RateLimitedApiKeyProps {
                CustomerId = "hello-customer",
                ApiStages = new [] { new UsagePlanPerApiStage { Stage = api.DeploymentStage } },
                Quota = new QuotaSettings {
                    Limit = 10000,
                    Period = Period.MONTH
                }
            });