@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)
110 lines • 4.81 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.ApiKey = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* The ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.
*
* ## Example Usage
* ### Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws_native from "@pulumi/aws-native";
*
* const config = new pulumi.Config();
* const apiKeyName = config.require("apiKeyName");
* const customerId = config.require("customerId");
* const generateDistinctId = config.require("generateDistinctId");
* const apiKey = new aws_native.apigateway.ApiKey("apiKey", {
* customerId: customerId,
* generateDistinctId: generateDistinctId,
* name: apiKeyName,
* });
*
* ```
* ### Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws_native from "@pulumi/aws-native";
*
* const config = new pulumi.Config();
* const apiKeyName = config.require("apiKeyName");
* const customerId = config.require("customerId");
* const generateDistinctId = config.require("generateDistinctId");
* const apiKey = new aws_native.apigateway.ApiKey("apiKey", {
* customerId: customerId,
* generateDistinctId: generateDistinctId,
* name: apiKeyName,
* });
*
* ```
*/
class ApiKey extends pulumi.CustomResource {
/**
* Get an existing ApiKey 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 ApiKey(name, undefined, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of ApiKey. 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'] === ApiKey.__pulumiType;
}
/**
* Create a ApiKey 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["customerId"] = args ? args.customerId : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["enabled"] = args ? args.enabled : undefined;
resourceInputs["generateDistinctId"] = args ? args.generateDistinctId : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["stageKeys"] = args ? args.stageKeys : undefined;
resourceInputs["tags"] = args ? args.tags : undefined;
resourceInputs["value"] = args ? args.value : undefined;
resourceInputs["apiKeyId"] = undefined /*out*/;
}
else {
resourceInputs["apiKeyId"] = undefined /*out*/;
resourceInputs["customerId"] = undefined /*out*/;
resourceInputs["description"] = undefined /*out*/;
resourceInputs["enabled"] = undefined /*out*/;
resourceInputs["generateDistinctId"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["stageKeys"] = undefined /*out*/;
resourceInputs["tags"] = undefined /*out*/;
resourceInputs["value"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const replaceOnChanges = { replaceOnChanges: ["generateDistinctId", "name", "value"] };
opts = pulumi.mergeOptions(opts, replaceOnChanges);
super(ApiKey.__pulumiType, name, resourceInputs, opts);
}
}
exports.ApiKey = ApiKey;
/** @internal */
ApiKey.__pulumiType = 'aws-native:apigateway:ApiKey';
//# sourceMappingURL=apiKey.js.map