Package software.amazon.awscdk.services.lambda

Interface CfnWebFunctionEndpoint.ThrottleConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebFunctionEndpoint.ThrottleConfigProperty.Jsii$Proxy

Enclosing class:

CfnWebFunctionEndpoint

@Stability(Stable)
public static interface CfnWebFunctionEndpoint.ThrottleConfigProperty
extends software.amazon.jsii.JsiiSerializable

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:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-throttleconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebFunctionEndpoint.ThrottleConfigProperty.Builder	builder()
default Number	getRateLimit()	The maximum request rate per second for the endpoint, up to a maximum of 10000.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRateLimit

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

The maximum request rate per second for the endpoint, up to a maximum of 10000.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-webfunctionendpoint-throttleconfig.html#cfn-lambda-webfunctionendpoint-throttleconfig-ratelimit

builder

@Stability(Stable)
static CfnWebFunctionEndpoint.ThrottleConfigProperty.Builder builder()

Returns:

a CfnWebFunctionEndpoint.ThrottleConfigProperty.Builder of CfnWebFunctionEndpoint.ThrottleConfigProperty