Interface IUsagePlanProps

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IUsagePlanProps

Syntax (vb)

Public Interface IUsagePlanProps

Remarks

ExampleMetadata: infused

Examples

LambdaIntegration integration;


var api = new RestApi(this, "hello-api");

var v1 = api.Root.AddResource("v1");
var echo = v1.AddResource("echo");
var echoMethod = echo.AddMethod("GET", integration, new MethodOptions { ApiKeyRequired = true });

var plan = api.AddUsagePlan("UsagePlan", new UsagePlanProps {
    Name = "Easy",
    Throttle = new ThrottleSettings {
        RateLimit = 10,
        BurstLimit = 2
    }
});

var key = api.AddApiKey("ApiKey");
plan.AddApiKey(key);

Synopsis

Properties

ApiStages	API Stages to be associated with the usage plan.
Description	Represents usage plan purpose.
Name	Name for this usage plan.
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 usage plan.

virtual IUsagePlanPerApiStage[] ApiStages { get; }

Property Value

IUsagePlanPerApiStage[]

Remarks

Default: none

Description

Represents usage plan purpose.

virtual string Description { get; }

Property Value

System.String

Remarks

Default: none

Name

Name for this usage plan.

virtual string Name { get; }

Property Value

System.String

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