@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
69 lines • 3.74 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.UsagePlan = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) 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 [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
*/
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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, opts) {
return new UsagePlan(name, undefined, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* 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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === UsagePlan.__pulumiType;
}
/**
* 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, args, opts) {
let resourceInputs = {};
opts = opts || {};
if (!opts.id) {
resourceInputs["apiStages"] = args ? args.apiStages : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["quota"] = args ? args.quota : undefined;
resourceInputs["tags"] = args ? args.tags : undefined;
resourceInputs["throttle"] = args ? args.throttle : undefined;
resourceInputs["usagePlanName"] = args ? args.usagePlanName : undefined;
resourceInputs["awsId"] = undefined /*out*/;
}
else {
resourceInputs["apiStages"] = undefined /*out*/;
resourceInputs["awsId"] = undefined /*out*/;
resourceInputs["description"] = undefined /*out*/;
resourceInputs["quota"] = undefined /*out*/;
resourceInputs["tags"] = undefined /*out*/;
resourceInputs["throttle"] = undefined /*out*/;
resourceInputs["usagePlanName"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(UsagePlan.__pulumiType, name, resourceInputs, opts);
}
}
exports.UsagePlan = UsagePlan;
/** @internal */
UsagePlan.__pulumiType = 'aws-native:apigateway:UsagePlan';
//# sourceMappingURL=usagePlan.js.map