Class: Aws::APIGateway::Types::UsagePlan

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

<div class=“remarks” markdown=“1”> In a usage plan, you associate an API by specifying the API’s Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

</div>

<div class=“seeAlso”>

Create and Use Usage Plans][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html

Instance Attribute Summary collapse

Instance Attribute Details

#api_stages ⇒ Array<Types::ApiStage>

The associated API stages of a usage plan.

Returns:



6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6788

class UsagePlan < Struct.new(
  :id,
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :product_code)
  include Aws::Structure
end

#description ⇒ String

The description of a usage plan.

Returns:

  • (String) 


6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6788

class UsagePlan < Struct.new(
  :id,
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :product_code)
  include Aws::Structure
end

#id ⇒ String

The identifier of a UsagePlan resource.

Returns:

  • (String) 


6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6788

class UsagePlan < Struct.new(
  :id,
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :product_code)
  include Aws::Structure
end

#name ⇒ String

The name of a usage plan.

Returns:

  • (String) 


6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6788

class UsagePlan < Struct.new(
  :id,
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :product_code)
  include Aws::Structure
end

#product_code ⇒ String

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Returns:

  • (String) 


6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6788

class UsagePlan < Struct.new(
  :id,
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :product_code)
  include Aws::Structure
end

#quota ⇒ Types::QuotaSettings

The maximum number of permitted requests per a given unit time interval.

Returns:



6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6788

class UsagePlan < Struct.new(
  :id,
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :product_code)
  include Aws::Structure
end

#throttle ⇒ Types::ThrottleSettings

The request throttle limits of a usage plan.

Returns:



6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
 
# File 'lib/aws-sdk-apigateway/types.rb', line 6788

class UsagePlan < Struct.new(
  :id,
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :product_code)
  include Aws::Structure
end