Table of Contents

Interface IRateLimitedApiKeyProps

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

RateLimitedApiKey properties.

public interface IRateLimitedApiKeyProps : IApiKeyProps, IApiKeyOptions, IResourceOptions
Inherited Members

Examples

RestApi api;


            var key = new RateLimitedApiKey(this, "rate-limited-api-key", new RateLimitedApiKeyProps {
                CustomerId = "hello-customer",
                Resources = new [] { api },
                Quota = new QuotaSettings {
                    Limit = 10000,
                    Period = Period.MONTH
                }
            });

Remarks

ExampleMetadata: infused

Properties

ApiStages

API Stages to be associated with the RateLimitedApiKey.

IUsagePlanPerApiStage[]? ApiStages { get; }

Property Value

IUsagePlanPerApiStage[]

Remarks

Default: none

Quota

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

IQuotaSettings? Quota { get; }

Property Value

IQuotaSettings

Remarks

Default: none

Throttle

Overall throttle settings for the API.

IThrottleSettings? Throttle { get; }

Property Value

IThrottleSettings

Remarks

Default: none