Show / Hide Table of Contents

Class UsagePlanPerApiStage

Represents the API stages that a usage plan applies to.

Inheritance
System.Object
UsagePlanPerApiStage
Implements
IUsagePlanPerApiStage
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UsagePlanPerApiStage : Object, IUsagePlanPerApiStage
Syntax (vb)
Public Class UsagePlanPerApiStage
    Inherits Object
    Implements IUsagePlanPerApiStage
Remarks

ExampleMetadata: infused

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

Synopsis

Constructors

UsagePlanPerApiStage()

Properties

Api
Stage

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

Throttle

Constructors

UsagePlanPerApiStage()

public UsagePlanPerApiStage()

Properties

Api

public IRestApi Api { get; set; }
Property Value

IRestApi

Remarks

Default: none

Stage

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

public Stage Stage { get; set; }
Property Value

Stage

Remarks

Default: none

Throttle

public IThrottlingPerMethod[] Throttle { get; set; }
Property Value

IThrottlingPerMethod[]

Remarks

Default: none

Implements

IUsagePlanPerApiStage
Back to top Generated by DocFX