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_stagesArray<Types::ApiStage>

The associated API stages of a usage plan.

Returns:



7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7370

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

#descriptionString

The description of a usage plan.

Returns:

  • (String)


7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7370

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

#idString

The identifier of a UsagePlan resource.

Returns:

  • (String)


7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7370

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

#nameString

The name of a usage plan.

Returns:

  • (String)


7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7370

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


7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7370

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

#quotaTypes::QuotaSettings

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



7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7370

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7370

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

#throttleTypes::ThrottleSettings

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



7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 7370

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