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 used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_stages ⇒ Array<Types::ApiStage>

The associated API stages of a usage plan.

Returns:



5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5882

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

#description ⇒ String

The description of a usage plan.

Returns:

  • (String) 


5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5882

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

#id ⇒ String

The identifier of a UsagePlan resource.

Returns:

  • (String) 


5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5882

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

#name ⇒ String

The name of a usage plan.

Returns:

  • (String) 


5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5882

class UsagePlan < Struct.new(
  :id,
  :name,
  :description,
  :api_stages,
  :throttle,
  :quota,
  :product_code,
  :tags)
  SENSITIVE = []
  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) 


5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5882

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

#quota ⇒ Types::QuotaSettings

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

Returns:



5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5882

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

#tags ⇒ Hash<String,String>

The collection of tags. Each tag element is associated with a given resource.

Returns:

  • (Hash<String,String>) 


5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5882

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

#throttle ⇒ Types::ThrottleSettings

A map containing method level throttling information for API stage in a usage plan.

Returns:



5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5882

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