software.amazon.awscdk.services.apigateway

Interface CfnUsagePlan.QuotaSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUsagePlan.QuotaSettingsProperty.Jsii$Proxy

Enclosing class:

CfnUsagePlan

@Stability(value=Stable)
public static interface CfnUsagePlan.QuotaSettingsProperty
extends software.amazon.jsii.JsiiSerializable

`QuotaSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 QuotaSettingsProperty quotaSettingsProperty = QuotaSettingsProperty.builder()
         .limit(123)
         .offset(123)
         .period("period")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUsagePlan.QuotaSettingsProperty.Builder A builder for CfnUsagePlan.QuotaSettingsProperty
static class	CfnUsagePlan.QuotaSettingsProperty.Jsii$Proxy An implementation for CfnUsagePlan.QuotaSettingsProperty

Method Summary

Modifier and Type	Method and Description
static CfnUsagePlan.QuotaSettingsProperty.Builder	builder()
default Number	getLimit() The target maximum number of requests that can be made in a given time period.
default Number	getOffset() The day that a time period starts.
default String	getPeriod() The time period for which the target maximum limit of requests applies, such as `DAY` or `WEEK` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLimit

@Stability(value=Stable)
 @Nullable
default Number getLimit()

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

getOffset

@Stability(value=Stable)
 @Nullable
default Number getOffset()

The day that a time period starts.

For example, with a time period of WEEK , an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

getPeriod

@Stability(value=Stable)
 @Nullable
default String getPeriod()

The time period for which the target maximum limit of requests applies, such as `DAY` or `WEEK` .

For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference .

builder

@Stability(value=Stable)
static CfnUsagePlan.QuotaSettingsProperty.Builder builder()

Returns:

a CfnUsagePlan.QuotaSettingsProperty.Builder of CfnUsagePlan.QuotaSettingsProperty