class Amazonite::ApiGateway::UsagePlan

• Amazonite::ApiGateway::UsagePlan
• Reference
• Object

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.

Included Modules

• JSON::Serializable

Defined in:

api_gateway/usage_plan.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(id : String | Nil = nil, name : String | Nil = nil, description : String | Nil = nil, api_stages : Array(ApiStage) | Nil = nil, throttle : ThrottleSettings | Nil = nil, quota : QuotaSettings | Nil = nil, product_code : String | Nil = nil, tags : Hash(String, String) | Nil = nil)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #api_stages : Array(ApiStage) | Nil

  The associated API stages of a usage plan.

• #api_stages=(api_stages : Array(ApiStage) | Nil)

  The associated API stages of a usage plan.

• #description : String | Nil

  The description of a usage plan.

• #description=(description : String | Nil)

  The description of a usage plan.

• #hash(hasher)

  See Object#hash(hasher)

• #id : String | Nil

  The identifier of a UsagePlan resource.

• #id=(id : String | Nil)

  The identifier of a UsagePlan resource.

• #name : String | Nil

  The name of a usage plan.

• #name=(name : String | Nil)

  The name of a usage plan.

• #product_code : String | Nil

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

• #product_code=(product_code : String | Nil)

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

• #quota : QuotaSettings | Nil

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

• #quota=(quota : QuotaSettings | Nil)

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

• #tags : Hash(String, String) | Nil

  The collection of tags.

• #tags=(tags : Hash(String, String) | Nil)

  The collection of tags.

• #throttle : ThrottleSettings | Nil

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

• #throttle=(throttle : ThrottleSettings | Nil)

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

• #validate! : Nil

Constructor Detail

Instance Method Detail