Class: AWSCDK::APIGateway::CfnUsagePlan::ThrottleSettingsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::APIGateway::CfnUsagePlan::ThrottleSettingsProperty

Defined in:

api_gateway/cfn_usage_plan.rb

Overview

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.

See Also:

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

Instance Attribute Summary

• #burst_limit ⇒ Numeric^? readonly

  The API target request burst rate limit.

• #rate_limit ⇒ Numeric^? readonly

  The API target request rate limit.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(burst_limit: nil, rate_limit: nil) ⇒ ThrottleSettingsProperty constructor

  A new instance of ThrottleSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(burst_limit: nil, rate_limit: nil) ⇒ ThrottleSettingsProperty

Returns a new instance of ThrottleSettingsProperty.

Parameters:

• burst_limit (Numeric, nil) (defaults to: nil) —

  The API target request burst rate limit.

• rate_limit (Numeric, nil) (defaults to: nil) —

  The API target request rate limit.

# File 'api_gateway/cfn_usage_plan.rb', line 714

def initialize(burst_limit: nil, rate_limit: nil)
  @burst_limit = burst_limit
  Jsii::Type.check_type(@burst_limit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "burstLimit") unless @burst_limit.nil?
  @rate_limit = rate_limit
  Jsii::Type.check_type(@rate_limit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "rateLimit") unless @rate_limit.nil?
end

Instance Attribute Details

#burst_limit ⇒ Numeric^? (readonly)

The API target request burst rate limit.

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

Returns:

• (Numeric, nil)

See Also:

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

# File 'api_gateway/cfn_usage_plan.rb', line 727

def burst_limit
  @burst_limit
end

#rate_limit ⇒ Numeric^? (readonly)

The API target request rate limit.

Returns:

• (Numeric, nil)

See Also:

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

# File 'api_gateway/cfn_usage_plan.rb', line 732

def rate_limit
  @rate_limit
end

Class Method Details

.jsii_properties ⇒ Object

# File 'api_gateway/cfn_usage_plan.rb', line 734

def self.jsii_properties
  {
    :burst_limit => "burstLimit",
    :rate_limit => "rateLimit",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'api_gateway/cfn_usage_plan.rb', line 741

def to_jsii
  result = {}
  result.merge!({
    "burstLimit" => @burst_limit,
    "rateLimit" => @rate_limit,
  })
  result.compact
end