Class CfnUsagePlan.ThrottleSettingsProperty

ThrottleSettings is a property of the AWS::ApiGateway::UsagePlan resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;

var throttleSettingsProperty = new ThrottleSettingsProperty {
    BurstLimit = 123,
    RateLimit = 123
};

Synopsis

Constructors

ThrottleSettingsProperty()

Properties

BurstLimit

The API target request burst rate limit.
RateLimit

The API target request rate limit.

Constructors

ThrottleSettingsProperty()

public ThrottleSettingsProperty()

Properties

BurstLimit

The API target request burst rate limit.

public Nullable<double> BurstLimit { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

This allows more requests through for a period of time than the target rate limit.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit

RateLimit

The API target request rate limit.

public Nullable<double> RateLimit { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit

Implements