class Amazonite::ApiGateway::CreateUsagePlanRequest

• Amazonite::ApiGateway::CreateUsagePlanRequest
• Reference
• Object

Overview

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

Included Modules

• JSON::Serializable

Defined in:

api_gateway/create_usage_plan_request.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(name : String, description : String | Nil = nil, api_stages : Array(ApiStage) | Nil = nil, throttle : ThrottleSettings | Nil = nil, quota : QuotaSettings | 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 the usage plan.

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

  The associated API stages of the usage plan.

• #description : String | Nil

  The description of the usage plan.

• #description=(description : String | Nil)

  The description of the usage plan.

• #hash(hasher)

  See Object#hash(hasher)

• #name : String

  The name of the usage plan.

• #name=(name : String)

  The name of the usage plan.

• #quota : QuotaSettings | Nil

  The quota of the usage plan.

• #quota=(quota : QuotaSettings | Nil)

  The quota of the usage plan.

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

  The key-value map of strings.

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

  The key-value map of strings.

• #throttle : ThrottleSettings | Nil

  The throttling limits of the usage plan.

• #throttle=(throttle : ThrottleSettings | Nil)

  The throttling limits of the usage plan.

• #validate! : Nil

Constructor Detail

Instance Method Detail