UNPKG

@lbrlabs/pulumi-grafana

Version:

A Pulumi package for creating and managing grafana.

85 lines 3.55 kB
"use strict"; // *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. *** // *** Do not edit by hand unless you're certain you know what you are doing! *** Object.defineProperty(exports, "__esModule", { value: true }); exports.CloudApiKey = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * Manages a single API key on the Grafana Cloud portal (on the organization level) * * [API documentation](https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#api-keys) * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as grafana from "@lbrlabs/pulumi-grafana"; * * const test = new grafana.CloudApiKey("test", { * cloudOrgSlug: "myorg", * role: "Admin", * }); * ``` * * ## Import * * ```sh * $ pulumi import grafana:index/cloudApiKey:CloudApiKey resource_name "{{org-name}}-{{api_key_name}}" * ``` */ class CloudApiKey extends pulumi.CustomResource { /** * Get an existing CloudApiKey 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 CloudApiKey(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of CloudApiKey. 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'] === CloudApiKey.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["cloudOrgSlug"] = state ? state.cloudOrgSlug : undefined; resourceInputs["key"] = state ? state.key : undefined; resourceInputs["name"] = state ? state.name : undefined; resourceInputs["role"] = state ? state.role : undefined; } else { const args = argsOrState; if ((!args || args.cloudOrgSlug === undefined) && !opts.urn) { throw new Error("Missing required property 'cloudOrgSlug'"); } if ((!args || args.role === undefined) && !opts.urn) { throw new Error("Missing required property 'role'"); } resourceInputs["cloudOrgSlug"] = args ? args.cloudOrgSlug : undefined; resourceInputs["name"] = args ? args.name : undefined; resourceInputs["role"] = args ? args.role : undefined; resourceInputs["key"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); const secretOpts = { additionalSecretOutputs: ["key"] }; opts = pulumi.mergeOptions(opts, secretOpts); super(CloudApiKey.__pulumiType, name, resourceInputs, opts); } } exports.CloudApiKey = CloudApiKey; /** @internal */ CloudApiKey.__pulumiType = 'grafana:index/cloudApiKey:CloudApiKey'; //# sourceMappingURL=cloudApiKey.js.map