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
show all
Defined in:
(unknown)

Overview

Note:

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: {
    burst_limit: 1,
    rate_limit: 1.0,
  },
  quota: {
    limit: 1,
    offset: 1,
    period: "DAY", # accepts DAY, WEEK, MONTH
  },
}

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

Instance Attribute Details

#api_stagesArray<Types::ApiStage>

The associated API stages of the usage plan.

Returns:

  • (Array<Types::ApiStage>)

    The associated API stages of the usage plan.

#descriptionString

The description of the usage plan.

Returns:

  • (String)

    The description of the usage plan.

#nameString

The name of the usage plan.

Returns:

  • (String)

    The name of the usage plan.

#quotaTypes::QuotaSettings

The quota of the usage plan.

Returns:

#throttleTypes::ThrottleSettings

The throttling limits of the usage plan.

Returns: