Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. getUsagePlan

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.getUsagePlan

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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 ID for the usage plan. For example: abc123 .
    Id string
    The ID for the usage plan. For example: abc123 .
    id String
    The ID for the usage plan. For example: abc123 .
    id string
    The ID for the usage plan. For example: abc123 .
    id str
    The ID for the usage plan. For example: abc123 .
    id String
    The ID for the usage plan. For example: abc123 .

    getUsagePlan Result

    The following output properties are available:

    ApiStages List<Pulumi.AwsNative.ApiGateway.Outputs.UsagePlanApiStage>
    The associated API stages of a usage plan.
    Description string
    The description of a usage plan.
    Id string
    The ID for the usage plan. For example: abc123 .
    Quota Pulumi.AwsNative.ApiGateway.Outputs.UsagePlanQuotaSettings
    The target maximum number of permitted requests per a given unit time interval.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The collection of tags. Each tag element is associated with a given resource.
    Throttle Pulumi.AwsNative.ApiGateway.Outputs.UsagePlanThrottleSettings
    A map containing method level throttling information for API stage in a usage plan.
    UsagePlanName string
    The name of a usage plan.
    ApiStages []UsagePlanApiStage
    The associated API stages of a usage plan.
    Description string
    The description of a usage plan.
    Id string
    The ID for the usage plan. For example: abc123 .
    Quota UsagePlanQuotaSettings
    The target maximum number of permitted requests per a given unit time interval.
    Tags Tag
    The collection of tags. Each tag element is associated with a given resource.
    Throttle UsagePlanThrottleSettings
    A map containing method level throttling information for API stage in a usage plan.
    UsagePlanName string
    The name of a usage plan.
    apiStages List<UsagePlanApiStage>
    The associated API stages of a usage plan.
    description String
    The description of a usage plan.
    id String
    The ID for the usage plan. For example: abc123 .
    quota UsagePlanQuotaSettings
    The target maximum number of permitted requests per a given unit time interval.
    tags List<Tag>
    The collection of tags. Each tag element is associated with a given resource.
    throttle UsagePlanThrottleSettings
    A map containing method level throttling information for API stage in a usage plan.
    usagePlanName String
    The name of a usage plan.
    apiStages UsagePlanApiStage[]
    The associated API stages of a usage plan.
    description string
    The description of a usage plan.
    id string
    The ID for the usage plan. For example: abc123 .
    quota UsagePlanQuotaSettings
    The target maximum number of permitted requests per a given unit time interval.
    tags Tag[]
    The collection of tags. Each tag element is associated with a given resource.
    throttle UsagePlanThrottleSettings
    A map containing method level throttling information for API stage in a usage plan.
    usagePlanName string
    The name of a usage plan.
    api_stages Sequence[UsagePlanApiStage]
    The associated API stages of a usage plan.
    description str
    The description of a usage plan.
    id str
    The ID for the usage plan. For example: abc123 .
    quota UsagePlanQuotaSettings
    The target maximum number of permitted requests per a given unit time interval.
    tags Sequence[root_Tag]
    The collection of tags. Each tag element is associated with a given resource.
    throttle UsagePlanThrottleSettings
    A map containing method level throttling information for API stage in a usage plan.
    usage_plan_name str
    The name of a usage plan.
    apiStages List<Property Map>
    The associated API stages of a usage plan.
    description String
    The description of a usage plan.
    id String
    The ID for the usage plan. For example: abc123 .
    quota Property Map
    The target maximum number of permitted requests per a given unit time interval.
    tags List<Property Map>
    The collection of tags. Each tag element is associated with a given resource.
    throttle Property Map
    A map containing method level throttling information for API stage in a usage plan.
    usagePlanName String
    The name of a usage plan.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    UsagePlanApiStage

    ApiId string
    API Id of the associated API stage in a usage plan.
    Stage string
    API stage name of the associated API stage in a usage plan.
    Throttle Dictionary<string, Pulumi.AwsNative.ApiGateway.Inputs.UsagePlanThrottleSettings>
    Map containing method level throttling information for API stage in a usage plan.
    ApiId string
    API Id of the associated API stage in a usage plan.
    Stage string
    API stage name of the associated API stage in a usage plan.
    Throttle map[string]UsagePlanThrottleSettings
    Map containing method level throttling information for API stage in a usage plan.
    apiId String
    API Id of the associated API stage in a usage plan.
    stage String
    API stage name of the associated API stage in a usage plan.
    throttle Map<String,UsagePlanThrottleSettings>
    Map containing method level throttling information for API stage in a usage plan.
    apiId string
    API Id of the associated API stage in a usage plan.
    stage string
    API stage name of the associated API stage in a usage plan.
    throttle {[key: string]: UsagePlanThrottleSettings}
    Map containing method level throttling information for API stage in a usage plan.
    api_id str
    API Id of the associated API stage in a usage plan.
    stage str
    API stage name of the associated API stage in a usage plan.
    throttle Mapping[str, UsagePlanThrottleSettings]
    Map containing method level throttling information for API stage in a usage plan.
    apiId String
    API Id of the associated API stage in a usage plan.
    stage String
    API stage name of the associated API stage in a usage plan.
    throttle Map<Property Map>
    Map containing method level throttling information for API stage in a usage plan.

    UsagePlanQuotaSettings

    Limit int
    The target maximum number of requests that can be made in a given time period.
    Offset int
    The number of requests subtracted from the given limit in the initial time period.
    Period string
    The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
    Limit int
    The target maximum number of requests that can be made in a given time period.
    Offset int
    The number of requests subtracted from the given limit in the initial time period.
    Period string
    The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
    limit Integer
    The target maximum number of requests that can be made in a given time period.
    offset Integer
    The number of requests subtracted from the given limit in the initial time period.
    period String
    The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
    limit number
    The target maximum number of requests that can be made in a given time period.
    offset number
    The number of requests subtracted from the given limit in the initial time period.
    period string
    The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
    limit int
    The target maximum number of requests that can be made in a given time period.
    offset int
    The number of requests subtracted from the given limit in the initial time period.
    period str
    The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
    limit Number
    The target maximum number of requests that can be made in a given time period.
    offset Number
    The number of requests subtracted from the given limit in the initial time period.
    period String
    The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

    UsagePlanThrottleSettings

    BurstLimit int
    The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
    RateLimit double
    The API target request rate limit.
    BurstLimit int
    The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
    RateLimit float64
    The API target request rate limit.
    burstLimit Integer
    The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
    rateLimit Double
    The API target request rate limit.
    burstLimit number
    The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
    rateLimit number
    The API target request rate limit.
    burst_limit int
    The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
    rate_limit float
    The API target request rate limit.
    burstLimit Number
    The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
    rateLimit Number
    The API target request rate limit.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native