Class QuotaSettings

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

Inheritance

System.Object

QuotaSettings

Implements

IQuotaSettings

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class QuotaSettings : Object, IQuotaSettings

Syntax (vb)

Public Class QuotaSettings
    Inherits Object
    Implements 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

Constructors

QuotaSettings()

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()

public QuotaSettings()

Properties

Limit

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

public Nullable<double> Limit { get; set; }

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.

public Nullable<double> Offset { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Default: none

Period

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

public Nullable<Period> Period { get; set; }

Property Value

System.Nullable<Period>

Remarks

Default: none

Implements

IQuotaSettings