Package 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(Stable)
public static interface CfnUsagePlan.QuotaSettingsProperty
extends software.amazon.jsii.JsiiSerializable

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.

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	Description
static final class	CfnUsagePlan.QuotaSettingsProperty.Builder	A builder for CfnUsagePlan.QuotaSettingsProperty
static final class	CfnUsagePlan.QuotaSettingsProperty.Jsii$Proxy	An implementation for CfnUsagePlan.QuotaSettingsProperty

Method Summary

Modifier and Type	Method	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 number of requests subtracted from the given limit in the initial time period.
default String	getPeriod()	The time period in which the limit applies.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLimit

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

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

getOffset

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

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

getPeriod

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

The time period in which the limit applies.

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

builder

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

Returns:

a CfnUsagePlan.QuotaSettingsProperty.Builder of CfnUsagePlan.QuotaSettingsProperty