pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin.inputs/UsagePlanQuotaSettingsArgs

UsagePlanQuotaSettingsArgs

data class UsagePlanQuotaSettingsArgs(val limit: Output<Int>? = null, val offset: Output<Int>? = null, val period: Output<String>? = null) : ConvertibleToJava<UsagePlanQuotaSettingsArgs>

Constructors

fun UsagePlanQuotaSettingsArgs(limit: Output<Int>? = null, offset: Output<Int>? = null, period: Output<String>? = null)

Functions

toJava

open override fun toJava(): UsagePlanQuotaSettingsArgs

Properties

limit

val limit: Output<Int>? = null

The maximum number of requests that users can make within the specified time period.

offset

val offset: Output<Int>? = null

For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.

period

val period: Output<String>? = null

The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.