import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Provides an API Gateway Usage Plan. * * ## Import * * Using `pulumi import`, import AWS API Gateway Usage Plan using the `id`. For example: * * ```sh * $ pulumi import aws:apigateway/usagePlan:UsagePlan myusageplan * ``` */ export declare class UsagePlan extends pulumi.CustomResource { /** * Get an existing UsagePlan resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: UsagePlanState, opts?: pulumi.CustomResourceOptions): UsagePlan; /** * Returns true if the given object is an instance of UsagePlan. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is UsagePlan; /** * Associated API stages of the usage plan. See `apiStages` Block below. */ readonly apiStages: pulumi.Output; /** * ARN of the usage plan. */ readonly arn: pulumi.Output; /** * Description of a usage plan. */ readonly description: pulumi.Output; /** * Name of the usage plan. */ readonly name: pulumi.Output; /** * AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace. */ readonly productCode: pulumi.Output; /** * Quota settings of the usage plan. See `quotaSettings` Block below. */ readonly quotaSettings: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Throttling limits of the usage plan. See `throttleSettings` Block below. */ readonly throttleSettings: pulumi.Output; /** * Create a UsagePlan resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args?: UsagePlanArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering UsagePlan resources. */ export interface UsagePlanState { /** * Associated API stages of the usage plan. See `apiStages` Block below. */ apiStages?: pulumi.Input[] | undefined>; /** * ARN of the usage plan. */ arn?: pulumi.Input; /** * Description of a usage plan. */ description?: pulumi.Input; /** * Name of the usage plan. */ name?: pulumi.Input; /** * AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace. */ productCode?: pulumi.Input; /** * Quota settings of the usage plan. See `quotaSettings` Block below. */ quotaSettings?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Throttling limits of the usage plan. See `throttleSettings` Block below. */ throttleSettings?: pulumi.Input; } /** * The set of arguments for constructing a UsagePlan resource. */ export interface UsagePlanArgs { /** * Associated API stages of the usage plan. See `apiStages` Block below. */ apiStages?: pulumi.Input[] | undefined>; /** * Description of a usage plan. */ description?: pulumi.Input; /** * Name of the usage plan. */ name?: pulumi.Input; /** * AWS Marketplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace. */ productCode?: pulumi.Input; /** * Quota settings of the usage plan. See `quotaSettings` Block below. */ quotaSettings?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Throttling limits of the usage plan. See `throttleSettings` Block below. */ throttleSettings?: pulumi.Input; } //# sourceMappingURL=usagePlan.d.ts.map