Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. getUsagePlanKey

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.getUsagePlanKey

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

    Using getUsagePlanKey

    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 getUsagePlanKey(args: GetUsagePlanKeyArgs, opts?: InvokeOptions): Promise<GetUsagePlanKeyResult>
function getUsagePlanKeyOutput(args: GetUsagePlanKeyOutputArgs, opts?: InvokeOptions): Output<GetUsagePlanKeyResult>
    def get_usage_plan_key(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetUsagePlanKeyResult
def get_usage_plan_key_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetUsagePlanKeyResult]
    func LookupUsagePlanKey(ctx *Context, args *LookupUsagePlanKeyArgs, opts ...InvokeOption) (*LookupUsagePlanKeyResult, error)
func LookupUsagePlanKeyOutput(ctx *Context, args *LookupUsagePlanKeyOutputArgs, opts ...InvokeOption) LookupUsagePlanKeyResultOutput

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

    public static class GetUsagePlanKey 
{
    public static Task<GetUsagePlanKeyResult> InvokeAsync(GetUsagePlanKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetUsagePlanKeyResult> Invoke(GetUsagePlanKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUsagePlanKeyResult> getUsagePlanKey(GetUsagePlanKeyArgs args, InvokeOptions options)
public static Output<GetUsagePlanKeyResult> getUsagePlanKey(GetUsagePlanKeyArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:apigateway:getUsagePlanKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID for the usage plan key. For example: abc123 .
    Id string
    The ID for the usage plan key. For example: abc123 .
    id String
    The ID for the usage plan key. For example: abc123 .
    id string
    The ID for the usage plan key. For example: abc123 .
    id str
    The ID for the usage plan key. For example: abc123 .
    id String
    The ID for the usage plan key. For example: abc123 .

    getUsagePlanKey Result

    The following output properties are available:

    Id string
    The ID for the usage plan key. For example: abc123 .
    Id string
    The ID for the usage plan key. For example: abc123 .
    id String
    The ID for the usage plan key. For example: abc123 .
    id string
    The ID for the usage plan key. For example: abc123 .
    id str
    The ID for the usage plan key. For example: abc123 .
    id String
    The ID for the usage plan key. For example: abc123 .

    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 Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native