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 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.

[1]: docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html

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:



5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5864

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) 


5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5864

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) 


5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5864

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) 


5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5864

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

#product_code ⇒ String

The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

Returns:

  • (String) 


5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5864

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:



5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5864

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>) 


5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5864

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:



5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
 
# File 'lib/aws-sdk-apigateway/types.rb', line 5864

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