Class QuotaSettings

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

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

public class QuotaSettings : IQuotaSettings

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

Examples

RestApi api;


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

Remarks

ExampleMetadata: infused

Constructors

QuotaSettings()

public QuotaSettings()

Properties

Limit

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

public double? Limit { get; set; }

Property Value

double?

Remarks

Default: none

Offset

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

public double? Offset { get; set; }

Property Value

double?

Remarks

Default: none

Period

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

public Period? Period { get; set; }

Property Value

Period?

Remarks

Default: none