Package software.amazon.awscdk.services.apigateway

Interface CfnUsagePlan.ThrottleSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUsagePlan.ThrottleSettingsProperty.Jsii$Proxy

Enclosing class:

CfnUsagePlan

@Stability(Stable)
public static interface CfnUsagePlan.ThrottleSettingsProperty
extends software.amazon.jsii.JsiiSerializable

ThrottleSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.

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.*;
 ThrottleSettingsProperty throttleSettingsProperty = ThrottleSettingsProperty.builder()
         .burstLimit(123)
         .rateLimit(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUsagePlan.ThrottleSettingsProperty.Builder	builder()
default Number	getBurstLimit()	The API target request burst rate limit.
default Number	getRateLimit()	The API target request rate limit.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBurstLimit

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

The API target request burst rate limit.

This allows more requests through for a period of time than the target rate limit.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit

getRateLimit

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

The API target request rate limit.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit

builder

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

Returns:

a CfnUsagePlan.ThrottleSettingsProperty.Builder of CfnUsagePlan.ThrottleSettingsProperty