software.amazon.awscdk.services.apigateway

Interface RateLimitedApiKeyProps

All Superinterfaces:

ApiKeyOptions, ApiKeyProps, ResourceOptions

All Known Implementing Classes:

RateLimitedApiKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:08.549Z")
public interface RateLimitedApiKeyProps
extends ApiKeyProps

RateLimitedApiKey properties.

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

Nested Class Summary

Nested Classes

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

Method Summary

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.

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

getCustomerId, getEnabled, getGenerateDistinctId, getResources

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

getApiKeyName, getDescription, getValue

Methods inherited from interface software.amazon.awscdk.services.apigateway.ResourceOptions

getDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions

Method Detail

getApiStages

default java.util.List<UsagePlanPerApiStage> getApiStages()

API Stages to be associated with the RateLimitedApiKey.

Default: none

getQuota

default QuotaSettings getQuota()

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

Default: none

getThrottle

default ThrottleSettings getThrottle()

Overall throttle settings for the API.

Default: none

builder

static RateLimitedApiKeyProps.Builder builder()

Specified by:

builder in interface ApiKeyOptions

Specified by:

builder in interface ApiKeyProps

Specified by:

builder in interface ResourceOptions

Returns:

a RateLimitedApiKeyProps.Builder of RateLimitedApiKeyProps