com.pulumi.awsnative.apigateway.kotlin.inputs.UsagePlanQuotaSettingsArgs.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 1.24.0.0

Show newest version

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.apigateway.kotlin.inputs

import com.pulumi.awsnative.apigateway.inputs.UsagePlanQuotaSettingsArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * ``QuotaSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.
 *  In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
 * @property limit The target maximum number of requests that can be made in a given time period.
 * @property offset The number of requests subtracted from the given limit in the initial time period.
 * @property period The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
 */
public data class UsagePlanQuotaSettingsArgs(
    public val limit: Output? = null,
    public val offset: Output? = null,
    public val period: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.apigateway.inputs.UsagePlanQuotaSettingsArgs =
        com.pulumi.awsnative.apigateway.inputs.UsagePlanQuotaSettingsArgs.builder()
            .limit(limit?.applyValue({ args0 -> args0 }))
            .offset(offset?.applyValue({ args0 -> args0 }))
            .period(period?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [UsagePlanQuotaSettingsArgs].
 */
@PulumiTagMarker
public class UsagePlanQuotaSettingsArgsBuilder internal constructor() {
    private var limit: Output? = null

    private var offset: Output? = null

    private var period: Output? = null

    /**
     * @param value The target maximum number of requests that can be made in a given time period.
     */
    @JvmName("trkoteabdfqppdcx")
    public suspend fun limit(`value`: Output) {
        this.limit = value
    }

    /**
     * @param value The number of requests subtracted from the given limit in the initial time period.
     */
    @JvmName("mxduworjicnjvcll")
    public suspend fun offset(`value`: Output) {
        this.offset = value
    }

    /**
     * @param value The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
     */
    @JvmName("tyukjbiqyopxfmjh")
    public suspend fun period(`value`: Output) {
        this.period = value
    }

    /**
     * @param value The target maximum number of requests that can be made in a given time period.
     */
    @JvmName("qkflbqfhxltuivyf")
    public suspend fun limit(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.limit = mapped
    }

    /**
     * @param value The number of requests subtracted from the given limit in the initial time period.
     */
    @JvmName("fuxottpiqgovsedi")
    public suspend fun offset(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.offset = mapped
    }

    /**
     * @param value The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
     */
    @JvmName("edpxmajlorfkstyy")
    public suspend fun period(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.period = mapped
    }

    internal fun build(): UsagePlanQuotaSettingsArgs = UsagePlanQuotaSettingsArgs(
        limit = limit,
        offset = offset,
        period = period,
    )
}