You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::UsagePlan

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#api_stages ⇒ Array<Types::ApiStage>

The associated API stages of a usage plan.

Returns:

#description ⇒ String

The description of a usage plan.

Returns:

  • (String) —

    The description of a usage plan.

#id ⇒ String

The identifier of a UsagePlan resource.

Returns:

  • (String) —

    The identifier of a UsagePlan resource.

#name ⇒ String

The name of a usage plan.

Returns:

  • (String) —

    The name of a usage plan.

#product_code ⇒ String

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

Returns:

  • (String) —

    The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

#quota ⇒ Types::QuotaSettings

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

Returns:

  • (Types::QuotaSettings) —

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) —

    The collection of tags.

#throttle ⇒ Types::ThrottleSettings

The request throttle limits of a usage plan.

Returns: