Table of Contents

Class CfnUsagePlan.QuotaSettingsProperty

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

QuotaSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies a target for the maximum number of requests users can make to your REST APIs.

public class CfnUsagePlan.QuotaSettingsProperty : CfnUsagePlan.IQuotaSettingsProperty
Inheritance
CfnUsagePlan.QuotaSettingsProperty
Implements
Inherited Members

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var quotaSettingsProperty = new QuotaSettingsProperty {
                 Limit = 123,
                 Offset = 123,
                 Period = "period"
             };

Remarks

In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using AWS Budgets to monitor costs and AWS WAF to manage API requests.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html

ExampleMetadata: fixture=_generated

Constructors

QuotaSettingsProperty()

public QuotaSettingsProperty()

Properties

Limit

The target maximum number of requests that can be made in a given time period.

public double? Limit { get; set; }

Property Value

double?

Remarks

Offset

The number of requests subtracted from the given limit in the initial time period.

public double? Offset { get; set; }

Property Value

double?

Remarks

Period

The time period in which the limit applies.

public string? Period { get; set; }

Property Value

string

Remarks