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 [AWS Budgets] to monitor costs and [AWS WAF] to manage API requests.

<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” markdown=“1”>

Create and Use Usage Plans][3

</div>

[1]: docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.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:



8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8149

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) 


8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8149

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) 


8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8149

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) 


8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8149

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) 


8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8149

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:



8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8149

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


8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8149

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

#throttle ⇒ Types::ThrottleSettings

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

Returns:



8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8149

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