You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

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.
[Create and Use Usage Plans][1]

Instance Attribute Summary collapse

Instance Attribute Details

#api_stagesArray<Types::ApiStage>

The associated API stages of a usage plan.

Returns:



6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6716

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

#descriptionString

The description of a usage plan.

Returns:

  • (String)


6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6716

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

#idString

The identifier of a UsagePlan resource.

Returns:

  • (String)


6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6716

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

#nameString

The name of a usage plan.

Returns:

  • (String)


6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6716

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

#product_codeString

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

Returns:

  • (String)


6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6716

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

#quotaTypes::QuotaSettings

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



6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6716

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

#throttleTypes::ThrottleSettings

The request throttle limits of a usage plan.



6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6716

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