← All packages

AWS Native

Pulumi Official

Package maintained by Pulumi

v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

Source code

UsagePlan

Resource Type definition for AWS::ApiGateway::UsagePlan

Create a UsagePlan Resource

new UsagePlan(name: string, args?: UsagePlanArgs, opts?: CustomResourceOptions);

@overload
def UsagePlan(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              api_stages: Optional[Sequence[UsagePlanApiStageArgs]] = None,
              description: Optional[str] = None,
              quota: Optional[UsagePlanQuotaSettingsArgs] = None,
              tags: Optional[Sequence[UsagePlanTagArgs]] = None,
              throttle: Optional[UsagePlanThrottleSettingsArgs] = None,
              usage_plan_name: Optional[str] = None)
@overload
def UsagePlan(resource_name: str,
              args: Optional[UsagePlanArgs] = None,
              opts: Optional[ResourceOptions] = None)

func NewUsagePlan(ctx *Context, name string, args *UsagePlanArgs, opts ...ResourceOption) (*UsagePlan, error)

public UsagePlan(string name, UsagePlanArgs? args = null, CustomResourceOptions? opts = null)

public UsagePlan(String name, UsagePlanArgs args)
public UsagePlan(String name, UsagePlanArgs args, CustomResourceOptions options)

type: aws-native:apigateway:UsagePlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UsagePlanArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args UsagePlanArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UsagePlanArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UsagePlanArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UsagePlanArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

UsagePlan Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The UsagePlan resource accepts the following input properties:

ApiStages List<Pulumi.AwsNative.ApiGateway.Inputs.UsagePlanApiStageArgs>: The API stages to associate with this usage plan.
Description string: A description of the usage plan.
Quota Pulumi.AwsNative.ApiGateway.Inputs.UsagePlanQuotaSettingsArgs: Configures the number of requests that users can make within a given interval.
Tags List<Pulumi.AwsNative.ApiGateway.Inputs.UsagePlanTagArgs>: An array of arbitrary tags (key-value pairs) to associate with the usage plan.
Throttle Pulumi.AwsNative.ApiGateway.Inputs.UsagePlanThrottleSettingsArgs: Configures the overall request rate (average requests per second) and burst capacity.
UsagePlanName string: A name for the usage plan.

ApiStages []UsagePlanApiStageArgs: The API stages to associate with this usage plan.
Description string: A description of the usage plan.
Quota UsagePlanQuotaSettingsArgs: Configures the number of requests that users can make within a given interval.
Tags []UsagePlanTagArgs: An array of arbitrary tags (key-value pairs) to associate with the usage plan.
Throttle UsagePlanThrottleSettingsArgs: Configures the overall request rate (average requests per second) and burst capacity.
UsagePlanName string: A name for the usage plan.

apiStages List<UsagePlanApiStageArgs>: The API stages to associate with this usage plan.
description String: A description of the usage plan.
quota UsagePlanQuotaSettingsArgs: Configures the number of requests that users can make within a given interval.
tags List<UsagePlanTagArgs>: An array of arbitrary tags (key-value pairs) to associate with the usage plan.
throttle UsagePlanThrottleSettingsArgs: Configures the overall request rate (average requests per second) and burst capacity.
usagePlanName String: A name for the usage plan.

apiStages UsagePlanApiStageArgs[]: The API stages to associate with this usage plan.
description string: A description of the usage plan.
quota UsagePlanQuotaSettingsArgs: Configures the number of requests that users can make within a given interval.
tags UsagePlanTagArgs[]: An array of arbitrary tags (key-value pairs) to associate with the usage plan.
throttle UsagePlanThrottleSettingsArgs: Configures the overall request rate (average requests per second) and burst capacity.
usagePlanName string: A name for the usage plan.

api_stages Sequence[UsagePlanApiStageArgs]: The API stages to associate with this usage plan.
description str: A description of the usage plan.
quota UsagePlanQuotaSettingsArgs: Configures the number of requests that users can make within a given interval.
tags Sequence[UsagePlanTagArgs]: An array of arbitrary tags (key-value pairs) to associate with the usage plan.
throttle UsagePlanThrottleSettingsArgs: Configures the overall request rate (average requests per second) and burst capacity.
usage_plan_name str: A name for the usage plan.

apiStages List<Property Map>: The API stages to associate with this usage plan.
description String: A description of the usage plan.
quota Property Map: Configures the number of requests that users can make within a given interval.
tags List<Property Map>: An array of arbitrary tags (key-value pairs) to associate with the usage plan.
throttle Property Map: Configures the overall request rate (average requests per second) and burst capacity.
usagePlanName String: A name for the usage plan.

Outputs

All input properties are implicitly available as output properties. Additionally, the UsagePlan resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Supporting Types

UsagePlanApiStage

ApiId string: The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
Stage string: The name of the stage to associate with the usage plan.
Throttle object: Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.

ApiId string: The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
Stage string: The name of the stage to associate with the usage plan.
Throttle interface{}: Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.

apiId String: The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
stage String: The name of the stage to associate with the usage plan.
throttle Object: Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.

apiId string: The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
stage string: The name of the stage to associate with the usage plan.
throttle any: Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.

api_id str: The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
stage str: The name of the stage to associate with the usage plan.
throttle Any: Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.

apiId String: The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
stage String: The name of the stage to associate with the usage plan.
throttle Any: Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed.

UsagePlanQuotaSettings

Limit int: The maximum number of requests that users can make within the specified time period.
Offset int: 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 string: 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.

Limit int: The maximum number of requests that users can make within the specified time period.
Offset int: 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 string: 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.

limit Integer: The maximum number of requests that users can make within the specified time period.
offset Integer: 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 String: 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.

limit number: The maximum number of requests that users can make within the specified time period.
offset number: 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 string: 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.

limit int: The maximum number of requests that users can make within the specified time period.
offset int: 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 str: 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.

limit Number: The maximum number of requests that users can make within the specified time period.
offset Number: 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 String: 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.

UsagePlanTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

UsagePlanThrottleSettings

BurstLimit int: The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
RateLimit double: The API request steady-state rate limit (average requests per second over an extended period of time).

BurstLimit int: The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
RateLimit float64: The API request steady-state rate limit (average requests per second over an extended period of time).

burstLimit Integer: The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
rateLimit Double: The API request steady-state rate limit (average requests per second over an extended period of time).

burstLimit number: The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
rateLimit number: The API request steady-state rate limit (average requests per second over an extended period of time).

burst_limit int: The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
rate_limit float: The API request steady-state rate limit (average requests per second over an extended period of time).

burstLimit Number: The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
rateLimit Number: The API request steady-state rate limit (average requests per second over an extended period of time).

Package Details

Repository: https://github.com/pulumi/pulumi-aws-native
License: Apache-2.0