Interface CfnUsagePlan.IQuotaSettingsProperty

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.

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IQuotaSettingsProperty

Syntax (vb)

Public Interface IQuotaSettingsProperty

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.

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

ExampleMetadata: fixture=_generated

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"
};

Synopsis

Properties

Limit	The target maximum number of requests that can be made in a given time period.
Offset	The number of requests subtracted from the given limit in the initial time period.
Period	The time period in which the limit applies.

Properties

Limit

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

virtual Nullable<double> Limit { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-limit

Offset

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

virtual Nullable<double> Offset { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-offset

Period

The time period in which the limit applies.

virtual string Period { get; }

Property Value

System.String

Remarks

Valid values are "DAY", "WEEK" or "MONTH".

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-period