@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
91 lines • 3.44 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");
/**
* Provides an AppSync API Key.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.appsync.GraphQLApi("example", {
* authenticationType: "API_KEY",
* name: "example",
* });
* const exampleApiKey = new aws.appsync.ApiKey("example", {
* apiId: example.id,
* expires: "2018-05-03T04:00:00Z",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_appsync_api_key` using the AppSync API ID and key separated by `:`. For example:
*
* ```sh
* $ pulumi import aws:appsync/apiKey:ApiKey example xxxxx:yyyyy
* ```
*/
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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new ApiKey(name, state, { ...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;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["apiId"] = state?.apiId;
resourceInputs["apiKeyId"] = state?.apiKeyId;
resourceInputs["description"] = state?.description;
resourceInputs["expires"] = state?.expires;
resourceInputs["key"] = state?.key;
resourceInputs["region"] = state?.region;
}
else {
const args = argsOrState;
if (args?.apiId === undefined && !opts.urn) {
throw new Error("Missing required property 'apiId'");
}
resourceInputs["apiId"] = args?.apiId;
resourceInputs["description"] = (args?.description) ?? "Managed by Pulumi";
resourceInputs["expires"] = args?.expires;
resourceInputs["region"] = args?.region;
resourceInputs["apiKeyId"] = undefined /*out*/;
resourceInputs["key"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["key"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(ApiKey.__pulumiType, name, resourceInputs, opts);
}
}
exports.ApiKey = ApiKey;
/** @internal */
ApiKey.__pulumiType = 'aws:appsync/apiKey:ApiKey';
//# sourceMappingURL=apiKey.js.map