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

CreateUsagePlanRequest

class 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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val apiStages: List<ApiStage>?

The associated API stages of the usage plan.

Link copied to clipboard
val description: String?

The description of the usage plan.

Link copied to clipboard
val name: String?

The name of the usage plan.

Link copied to clipboard
val quota: QuotaSettings?

The quota of the usage plan.

Link copied to clipboard
val tags: Map<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.

Link copied to clipboard
val throttle: ThrottleSettings?

The throttling limits of the usage plan.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String