aws-cdk-lib.aws_apigateway.CfnUsagePlan.ThrottleSettingsProperty

interface ThrottleSettingsProperty

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnUsagePlan.ThrottleSettingsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnUsagePlan_ThrottleSettingsProperty
Javasoftware.amazon.awscdk.services.apigateway.CfnUsagePlan.ThrottleSettingsProperty
Pythonaws_cdk.aws_apigateway.CfnUsagePlan.ThrottleSettingsProperty
TypeScript aws-cdk-lib » aws_apigateway » CfnUsagePlan » ThrottleSettingsProperty

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 { aws_apigateway as apigateway } from 'aws-cdk-lib';
const throttleSettingsProperty: apigateway.CfnUsagePlan.ThrottleSettingsProperty = {
  burstLimit: 123,
  rateLimit: 123,
};

Properties

NameTypeDescription
burstLimit?numberThe API target request burst rate limit.
rateLimit?numberThe API target request rate limit.

burstLimit?

Type: number (optional)

The API target request burst rate limit.

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


rateLimit?

Type: number (optional)

The API target request rate limit.