AWS Native

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

getUsagePlan

Resource Type definition for AWS::ApiGateway::UsagePlan

Using getUsagePlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUsagePlan(args: GetUsagePlanArgs, opts?: InvokeOptions): Promise<GetUsagePlanResult>
function getUsagePlanOutput(args: GetUsagePlanOutputArgs, opts?: InvokeOptions): Output<GetUsagePlanResult>
def get_usage_plan(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetUsagePlanResult
def get_usage_plan_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetUsagePlanResult]
func LookupUsagePlan(ctx *Context, args *LookupUsagePlanArgs, opts ...InvokeOption) (*LookupUsagePlanResult, error)
func LookupUsagePlanOutput(ctx *Context, args *LookupUsagePlanOutputArgs, opts ...InvokeOption) LookupUsagePlanResultOutput

> Note: This function is named LookupUsagePlan in the Go SDK.

public static class GetUsagePlan 
{
    public static Task<GetUsagePlanResult> InvokeAsync(GetUsagePlanArgs args, InvokeOptions? opts = null)
    public static Output<GetUsagePlanResult> Invoke(GetUsagePlanInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetUsagePlanResult> getUsagePlan(GetUsagePlanArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:apigateway:getUsagePlan
  Arguments:
    # Arguments dictionary

The following arguments are supported:

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.

getUsagePlan Result

The following output properties are available:

ApiStages List<Pulumi.AwsNative.ApiGateway.Outputs.UsagePlanApiStage>

The API stages to associate with this usage plan.

Description string

A description of the usage plan.

Id string

The provider-assigned unique ID for this managed resource.

Quota Pulumi.AwsNative.ApiGateway.Outputs.UsagePlanQuotaSettings

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

Tags List<Pulumi.AwsNative.ApiGateway.Outputs.UsagePlanTag>

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

Throttle Pulumi.AwsNative.ApiGateway.Outputs.UsagePlanThrottleSettings

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

UsagePlanName string

A name for the usage plan.

ApiStages []UsagePlanApiStage

The API stages to associate with this usage plan.

Description string

A description of the usage plan.

Id string

The provider-assigned unique ID for this managed resource.

Quota UsagePlanQuotaSettings

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

Tags []UsagePlanTag

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

Throttle UsagePlanThrottleSettings

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

UsagePlanName string

A name for the usage plan.

apiStages List<UsagePlanApiStage>

The API stages to associate with this usage plan.

description String

A description of the usage plan.

id String

The provider-assigned unique ID for this managed resource.

quota UsagePlanQuotaSettings

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

tags List<UsagePlanTag>

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

throttle UsagePlanThrottleSettings

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

usagePlanName String

A name for the usage plan.

apiStages UsagePlanApiStage[]

The API stages to associate with this usage plan.

description string

A description of the usage plan.

id string

The provider-assigned unique ID for this managed resource.

quota UsagePlanQuotaSettings

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

tags UsagePlanTag[]

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

throttle UsagePlanThrottleSettings

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

usagePlanName string

A name for the usage plan.

api_stages Sequence[UsagePlanApiStage]

The API stages to associate with this usage plan.

description str

A description of the usage plan.

id str

The provider-assigned unique ID for this managed resource.

quota UsagePlanQuotaSettings

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

tags Sequence[UsagePlanTag]

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

throttle UsagePlanThrottleSettings

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.

id String

The provider-assigned unique ID for this managed resource.

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.

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