@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-25T18:29:08.549Z") public interface RateLimitedApiKeyProps extends ApiKeyProps
Example:
RestApi api; RateLimitedApiKey key = RateLimitedApiKey.Builder.create(this, "rate-limited-api-key") .customerId("hello-customer") .resources(List.of(api)) .quota(QuotaSettings.builder() .limit(10000) .period(Period.MONTH) .build()) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
RateLimitedApiKeyProps.Builder
A builder for
RateLimitedApiKeyProps |
static class |
RateLimitedApiKeyProps.Jsii$Proxy
An implementation for
RateLimitedApiKeyProps |
Modifier and Type | Method and Description |
---|---|
static RateLimitedApiKeyProps.Builder |
builder() |
default java.util.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.
|
getCustomerId, getEnabled, getGenerateDistinctId, getResources
getApiKeyName, getDescription, getValue
getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions
default java.util.List<UsagePlanPerApiStage> getApiStages()
Default: none
default QuotaSettings getQuota()
Default: none
default ThrottleSettings getThrottle()
Default: none
static RateLimitedApiKeyProps.Builder builder()
builder
in interface ApiKeyOptions
builder
in interface ApiKeyProps
builder
in interface ResourceOptions
RateLimitedApiKeyProps.Builder
of RateLimitedApiKeyProps