Class UsagePlanPerApiStage

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Represents the API stages that a usage plan applies to.

public class UsagePlanPerApiStage : IUsagePlanPerApiStage

Inheritance

object

UsagePlanPerApiStage

Implements

IUsagePlanPerApiStage

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

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