pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin/UsagePlanArgs

UsagePlanArgs

data class UsagePlanArgs(val apiStages: Output<List<UsagePlanApiStageArgs>>? = null, val description: Output<String>? = null, val quota: Output<UsagePlanQuotaSettingsArgs>? = null, val tags: Output<List<UsagePlanTagArgs>>? = null, val throttle: Output<UsagePlanThrottleSettingsArgs>? = null, val usagePlanName: Output<String>? = null) : ConvertibleToJava<UsagePlanArgs>

Resource Type definition for AWS::ApiGateway::UsagePlan

Constructors

Link copied to clipboard
fun UsagePlanArgs(apiStages: Output<List<UsagePlanApiStageArgs>>? = null, description: Output<String>? = null, quota: Output<UsagePlanQuotaSettingsArgs>? = null, tags: Output<List<UsagePlanTagArgs>>? = null, throttle: Output<UsagePlanThrottleSettingsArgs>? = null, usagePlanName: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): UsagePlanArgs

Properties

Link copied to clipboard
val apiStages: Output<List<UsagePlanApiStageArgs>>? = null

The API stages to associate with this usage plan.

Link copied to clipboard
val description: Output<String>? = null

A description of the usage plan.

Link copied to clipboard
val quota: Output<UsagePlanQuotaSettingsArgs>? = null

Configures the number of requests that users can make within a given interval.

Link copied to clipboard
val tags: Output<List<UsagePlanTagArgs>>? = null

An array of arbitrary tags (key-value pairs) to associate with the usage plan.

Link copied to clipboard
val throttle: Output<UsagePlanThrottleSettingsArgs>? = null

Configures the overall request rate (average requests per second) and burst capacity.

Link copied to clipboard
val usagePlanName: Output<String>? = null

A name for the usage plan.