Interface IUsagePlanPerApiStage

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Represents the API stages that a usage plan applies to.

public interface IUsagePlanPerApiStage

Examples

UsagePlan plan;
            RestApi api;
            Method echoMethod;


            plan.AddApiStage(new UsagePlanPerApiStage {
                Stage = api.DeploymentStage,
                Throttle = new [] { new ThrottlingPerMethod {
                    Method = echoMethod,
                    Throttle = new ThrottleSettings {
                        RateLimit = 10,
                        BurstLimit = 2
                    }
                } }
            });

Remarks

ExampleMetadata: infused

Properties

Api

IRestApi? Api { get; }

Property Value

IRestApi

Remarks

Default: none

Stage

[disable-awslint:ref-via-interface].

Stage? Stage { get; }

Property Value

Stage

Remarks

Default: none

Throttle

IThrottlingPerMethod[]? Throttle { get; }

Property Value

IThrottlingPerMethod[]

Remarks

Default: none