apigateway/aws.sdk.kotlin.services.apigateway.model/UsagePlan

UsagePlan

class UsagePlan

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.

Types

object Companion

Properties

val apiStages: List<ApiStage>?

The associated API stages of a usage plan.

val description: String?

The description of a usage plan.

val id: String?

The identifier of a UsagePlan resource.

val name: String?

The name of a usage plan.

val productCode: String?

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

val quota: QuotaSettings?

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

val tags: Map<String, String>?

The collection of tags. Each tag element is associated with a given resource.

val throttle: ThrottleSettings?

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

Functions

inline fun copy(block: UsagePlan.Builder.() -> Unit = {}): UsagePlan

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String