class Aws::APIGateway::Types::CreateUsagePlanRequest

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.

@note When making an API call, you may pass CreateUsagePlanRequest

data as a 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",
      },
    }

@!attribute [rw] name

\[Required\] The name of the usage plan.
@return [String]

@!attribute [rw] description

The description of the usage plan.
@return [String]

@!attribute [rw] api_stages

The associated API stages of the usage plan.
@return [Array<Types::ApiStage>]

@!attribute [rw] throttle

The throttling limits of the usage plan.
@return [Types::ThrottleSettings]

@!attribute [rw] quota

The quota of the usage plan.
@return [Types::QuotaSettings]

@!attribute [rw] tags

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.
@return [Hash<String,String>]

Constants

SENSITIVE