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]

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:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8142

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) 


8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8142

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) 


8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8142

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) 


8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8142

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) 


8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8142

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

#quota ⇒ Types::QuotaSettings

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

Returns:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8142

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


8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8142

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

#throttle ⇒ Types::ThrottleSettings

The request throttle limits of a usage plan.

Returns:



8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 8142

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