Skip to content
v2.277.0

ThrottleConfigProperty Struct ​

The throttling configuration for the endpoint.

Optionally constrains the request rate that the endpoint accepts, in addition to your account's rate limit quota.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const throttleConfigProperty: lambda.CfnWebFunctionEndpoint.ThrottleConfigProperty = {
  rateLimit: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lambda as lambda_

throttle_config_property = lambda.CfnWebFunctionEndpoint.ThrottleConfigProperty(
    rate_limit=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lambda.*;

ThrottleConfigProperty throttleConfigProperty = ThrottleConfigProperty.builder()
        .rateLimit(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lambda;

var throttleConfigProperty = new ThrottleConfigProperty {
    RateLimit = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

throttleConfigProperty := &ThrottleConfigProperty{
	RateLimit: jsii.Number(123),
}

Properties ​

rateLimitoptionalnumberrate_limitoptionalint | floatrateLimitoptionalNumberRateLimitoptionaldoubleRateLimitoptional*float64 #
The maximum request rate per second for the endpoint, up to a maximum of 10000.
notes

This optional limit further constrains the endpoint's request rate. When omitted, the endpoint's request rate is limited only by your account's rate limit quota. Specify 0 to reject all new requests. Other supported values are 100 through 1000 in increments of 100, and 2000 through 10000 in increments of 1000. Supported values can vary by Region; if you specify an unsupported value, the error lists the values available in that Region.