Package software.amazon.awscdk.services.apigatewayv2

Interface RateLimitedApiKeyProps

All Superinterfaces:

ApiKeyOptions, ApiKeyProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RateLimitedApiKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-08-20T12:34:37.210Z")
@Stability(Stable)
public interface RateLimitedApiKeyProps
extends software.amazon.jsii.JsiiSerializable, ApiKeyProps

RateLimitedApiKey properties.

Example:

 WebSocketApi api;
 WebSocketStage stage;
 RateLimitedApiKey key = RateLimitedApiKey.Builder.create(this, "rate-limited-api-key")
         .customerId("test-customer")
         .apiStages(List.of(UsagePlanPerApiStage.builder()
                 .api(api)
                 .stage(stage)
                 .build()))
         .quota(QuotaSettings.builder()
                 .limit(10000)
                 .period(Period.MONTH)
                 .build())
         .throttle(ThrottleSettings.builder()
                 .rateLimit(100)
                 .burstLimit(200)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RateLimitedApiKeyProps.Builder	builder()
default List<UsagePlanPerApiStage>	getApiStages()	API Stages to be associated with the RateLimitedApiKey.
default QuotaSettings	getQuota()	Number of requests clients can make in a given time period.
default ThrottleSettings	getThrottle()	Overall throttle settings for the API.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.ApiKeyOptions

getApiKeyName, getDescription, getValue

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.ApiKeyProps

getCustomerId, getEnabled, getGenerateDistinctId

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiStages

@Stability(Stable)
@Nullable
default List<UsagePlanPerApiStage> getApiStages()

API Stages to be associated with the RateLimitedApiKey.

Default: none

getQuota

@Stability(Stable)
@Nullable
default QuotaSettings getQuota()

Number of requests clients can make in a given time period.

Default: none

getThrottle

@Stability(Stable)
@Nullable
default ThrottleSettings getThrottle()

Overall throttle settings for the API.

Default: none

builder

@Stability(Stable)
static RateLimitedApiKeyProps.Builder builder()

Returns:

a RateLimitedApiKeyProps.Builder of RateLimitedApiKeyProps