You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::CreateUsagePlanRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateUsagePlanRequest
- Defined in:
- (unknown)
Overview
When passing CreateUsagePlanRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
name: "String", # required
description: "String",
api_stages: [
{
api_id: "String",
stage: "String",
throttle: {
"String" => {
burst_limit: 1,
rate_limit: 1.0,
},
},
},
],
throttle: {
burst_limit: 1,
rate_limit: 1.0,
},
quota: {
limit: 1,
offset: 1,
period: "DAY", # accepts DAY, WEEK, MONTH
},
tags: {
"String" => "String",
},
}
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.
Instance Attribute Summary collapse
-
#api_stages ⇒ Array<Types::ApiStage>
The associated API stages of the usage plan.
-
#description ⇒ String
The description of the usage plan.
-
#name ⇒ String
[Required] The name of the usage plan.
-
#quota ⇒ Types::QuotaSettings
The quota of the usage plan.
-
#tags ⇒ Hash<String,String>
The key-value map of strings.
-
#throttle ⇒ Types::ThrottleSettings
The throttling limits of the usage plan.
Instance Attribute Details
#api_stages ⇒ Array<Types::ApiStage>
The associated API stages of the usage plan.
#description ⇒ String
The description of the usage plan.
#name ⇒ String
[Required] The name of the usage plan.
#quota ⇒ Types::QuotaSettings
The quota of the usage plan.
#tags ⇒ Hash<String,String>
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with aws:
. The tag value can be up to 256 characters.
#throttle ⇒ Types::ThrottleSettings
The throttling limits of the usage plan.