Class CfnUsagePlan.ThrottleSettingsProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

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.

public class CfnUsagePlan.ThrottleSettingsProperty : CfnUsagePlan.IThrottleSettingsProperty

Inheritance

object

CfnUsagePlan.ThrottleSettingsProperty

Implements

CfnUsagePlan.IThrottleSettingsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

Remarks

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

ExampleMetadata: fixture=_generated

Constructors

ThrottleSettingsProperty()

public ThrottleSettingsProperty()

Properties

BurstLimit

The API target request burst rate limit.

public double? BurstLimit { get; set; }

Property Value

double?

Remarks

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

Link: 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 double? RateLimit { get; set; }

Property Value

double?

Remarks

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