Interface IRateLimitedApiKeyProps

RateLimitedApiKey properties.

Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IRateLimitedApiKeyProps : IApiKeyProps, IApiKeyOptions, IResourceOptions
Syntax (vb)
Public Interface IRateLimitedApiKeyProps
    Inherits IApiKeyProps, IApiKeyOptions, IResourceOptions
Remarks

ExampleMetadata: infused

Examples
RestApi api;


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

Synopsis

Properties

ApiStages

API Stages to be associated with the RateLimitedApiKey.
Quota

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

Overall throttle settings for the API.

Properties

ApiStages

API Stages to be associated with the RateLimitedApiKey.

virtual IUsagePlanPerApiStage[] ApiStages { get; }
Property Value

IUsagePlanPerApiStage[]

Remarks

Default: none

Quota

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

virtual IQuotaSettings Quota { get; }
Property Value

IQuotaSettings

Remarks

Default: none

Throttle

Overall throttle settings for the API.

virtual IThrottleSettings Throttle { get; }
Property Value

IThrottleSettings

Remarks

Default: none