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

UsagePlan

class UsagePlan : KotlinCustomResource

The `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see Creating and Using API Usage Plans in Amazon API Gateway in the API Gateway Developer Guide. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using to monitor costs and to manage API requests.

Properties

val apiStages: Output<List<UsagePlanApiStage>>?

The associated API stages of a usage plan.

val awsId: Output<String>

The ID for the usage plan. For example: abc123 .

val description: Output<String>?

The description of a usage plan.

val id: Output<String>

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

val quota: Output<UsagePlanQuotaSettings>?

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

val tags: Output<List<Tag>>?

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

val throttle: Output<UsagePlanThrottleSettings>?

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

val urn: Output<String>

val usagePlanName: Output<String>?

The name of a usage plan.