Class: Aws::APIGateway::Types::ThrottleSettings

Inherits:

Struct

Object
Struct
Aws::APIGateway::Types::ThrottleSettings

show all

Defined in:: gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass ThrottleSettings data as a hash:

{
  burst_limit: 1,
  rate_limit: 1.0,
}

The API request rate limits.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#burst_limit ⇒ Integer
The API target request burst rate limit.
#rate_limit ⇒ Float
The API target request rate limit.

Instance Attribute Details

#burst_limit ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6252

class ThrottleSettings < Struct.new(
  :burst_limit,
  :rate_limit)
  SENSITIVE = []
  include Aws::Structure
end

#rate_limit ⇒ `Float`

The API target request rate limit.